{"id":48442,"date":"2025-02-08T08:36:33","date_gmt":"2025-02-08T08:36:33","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=48442"},"modified":"2025-07-12T05:38:41","modified_gmt":"2025-07-12T05:38:41","slug":"docker-inspect-2","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/docker-inspect-2\/","title":{"rendered":"Docker commands Guide – docker inspect with examples"},"content":{"rendered":"\n

Here\u2019s a complete tutorial<\/strong> on docker inspect<\/code>, covering what it does<\/strong>, examples<\/strong>, and use cases<\/strong>.<\/p>\n\n\n\n

\n\n\n\n

What is docker inspect<\/code>?<\/strong><\/h2>\n\n\n\n

docker inspect<\/code> is a Docker command that retrieves detailed information<\/strong> about Docker objects, such as containers, images, networks, and volumes<\/strong>. It returns the full JSON-formatted metadata<\/strong>, including configuration, network settings, resource usage, and more.<\/p>\n\n\n\n

Key Features:<\/strong><\/h3>\n\n\n\n
    \n
  • Retrieves deep insights<\/strong> into Docker objects.<\/li>\n\n\n\n
  • Helps in troubleshooting and debugging<\/strong> containers and networks.<\/li>\n\n\n\n
  • Supports filtering and formatting<\/strong> the output for specific fields.<\/li>\n<\/ul>\n\n\n\n
    \n\n\n\n

    Basic Syntax<\/strong><\/h2>\n\n\n
    docker inspect [OPTIONS] NAME|ID [NAME|ID...]\n<\/code><\/span><\/pre>\n\n\n
    Common Options:<\/strong><\/h3>\n\n\n\n
      \n
    • -f<\/code>, --format<\/code>: Format the output using Go templates ({{.State.Status}}<\/code>).<\/li>\n\n\n\n
    • --type<\/code>: Specify the object type (container<\/code>, image<\/code>, network<\/code>, or volume<\/code>).<\/li>\n<\/ul>\n\n\n\n
      \n\n\n\n
      Examples of docker inspect<\/code><\/strong><\/h2>\n\n\n\n
      1. Inspect a Running Container<\/strong><\/h3>\n\n\n
      docker inspect my_container\n<\/code><\/span><\/pre>\n\n\n
      This returns a JSON document containing detailed information about my_container<\/code>.<\/p>\n\n\n\n
      \n\n\n\n
      2. Inspect an Image<\/strong><\/h3>\n\n\n
      docker<\/span> inspect<\/span> nginx<\/span>:latest<\/span>\n<\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
      This shows metadata about the nginx:latest<\/code> image, such as the layers, commands used to build it, and environment variables.<\/p>\n\n\n\n
      \n\n\n\n
      3. Inspect a Network<\/strong><\/h3>\n\n\n
      docker inspect my_custom_network\n<\/code><\/span><\/pre>\n\n\n
      This returns network configuration details like subnet, gateway, and connected containers<\/strong>.<\/p>\n\n\n\n
      \n\n\n\n
      4. Inspect a Volume<\/strong><\/h3>\n\n\n
      docker inspect my_data_volume\n<\/code><\/span><\/pre>\n\n\n
      This provides information about the volume, including its mount point and usage.<\/p>\n\n\n\n
      \n\n\n\n
      5. Format the Output to Show a Specific Field<\/strong><\/h3>\n\n\n
      docker inspect -f '{{.State.Status}}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      Example Output:<\/strong><\/p>\n\n\n
      running\n<\/code><\/span><\/pre>\n\n\n
      This extracts the container\u2019s status<\/strong> (running, exited, etc.).<\/p>\n\n\n\n
      \n\n\n\n
      6. Show Container\u2019s IP Address<\/strong><\/h3>\n\n\n
      docker inspect -f '{{.NetworkSettings.IPAddress}}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      Example Output:<\/strong><\/p>\n\n\n
      172.17<\/span>.0<\/span>.2<\/span>\n<\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
      \n\n\n\n
      7. Show the Base Image of a Container<\/strong><\/h3>\n\n\n
      docker inspect -f '{{.Config.Image}}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      \n\n\n\n
      8. Check the Mount Point of a Volume<\/strong><\/h3>\n\n\n
      docker inspect -f '{{.Mountpoint}}'<\/span> my_data_volume\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      \n\n\n\n
      9. Use JSON Formatting for Better Readability<\/strong><\/h3>\n\n\n
      docker inspect my_container | jq '.'<\/span>\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      This pipes the JSON output to jq<\/code> for pretty-printing and easier reading.<\/p>\n\n\n\n
      \n\n\n\n
      10. Inspect Multiple Containers at Once<\/strong><\/h3>\n\n\n
      docker inspect my_container1 my_container2\n<\/code><\/span><\/pre>\n\n\n
      This returns JSON data for both containers.<\/p>\n\n\n\n
      \n\n\n\n
      11. Filter Containers with Specific Metadata<\/strong><\/h3>\n\n\n\n
      List all containers and filter for those with a specific status:<\/p>\n\n\n
      docker inspect -f '{{.Name}}: {{.State.Status}}'<\/span> $(docker ps -q)\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      \n\n\n\n
      12. Find Environment Variables in a Container<\/strong><\/h3>\n\n\n
      docker inspect -f '{{json .Config.Env}}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      Example Output:<\/strong><\/p>\n\n\n
      [\"PATH=\/usr\/local\/sbin:\/usr\/local\/bin:\/usr\/sbin:\/usr\/bin\"<\/span>, \"APP_ENV=production\"<\/span>]\n<\/code><\/span>Code language:<\/span> JSON \/ JSON with Comments<\/span> (<\/span>json<\/span>)<\/span><\/small><\/pre>\n\n\n
      \n\n\n\n
      13. Get CPU and Memory Limits<\/strong><\/h3>\n\n\n
      docker inspect -f 'CPU: {{.HostConfig.NanoCpus}}, Memory: {{.HostConfig.Memory}}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      \n\n\n\n
      14. Save Inspection Data to a File<\/strong><\/h3>\n\n\n
      docker<\/span> inspect<\/span> my_container<\/span> > container_info<\/span>.json<\/span>\n<\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
      \n\n\n\n
      Use Cases for docker inspect<\/code><\/strong><\/h2>\n\n\n\n
      1. Debugging and Troubleshooting<\/strong><\/h3>\n\n\n\n
        \n
      • Inspect container logs and metadata to diagnose problems.<\/li>\n\n\n\n
      • Example: Check the container\u2019s restart policy<\/strong> or network configuration<\/strong> to identify issues.<\/li>\n<\/ul>\n\n\n\n
        2. Verifying Container Configurations<\/strong><\/h3>\n\n\n\n
          \n
        • Ensure containers are configured with the correct environment variables, resource limits, and command options<\/strong>.<\/li>\n\n\n\n
        • Example: Verify that a database container is using the expected port and volume.<\/li>\n<\/ul>\n\n\n\n
          3. Auditing and Security<\/strong><\/h3>\n\n\n\n
            \n
          • Audit images for base image and build commands<\/strong>.<\/li>\n\n\n\n
          • Example: Ensure that containers do not contain unnecessary or outdated software.<\/li>\n<\/ul>\n\n\n\n
            4. Network Analysis<\/strong><\/h3>\n\n\n\n
              \n
            • Inspect Docker networks to find IP addresses, subnets, and connected containers<\/strong>.<\/li>\n\n\n\n
            • Example: Check if a container is connected to the right network.<\/li>\n<\/ul>\n\n\n\n
              5. Monitoring and Resource Management<\/strong><\/h3>\n\n\n\n
                \n
              • Monitor resource allocations for containers, such as CPU and memory limits<\/strong>.<\/li>\n\n\n\n
              • Example: Track containers that exceed their allocated memory.<\/li>\n<\/ul>\n\n\n\n
                6. Automating Configuration Checks<\/strong><\/h3>\n\n\n\n
                  \n
                • Integrate docker inspect<\/code> into scripts to automatically validate container configurations.<\/li>\n<\/ul>\n\n\n\n
                  \n\n\n\n
                  List of Common docker inspect<\/code> Commands<\/strong><\/h2>\n\n\n\n
                  Command<\/strong><\/th>Description<\/strong><\/th><\/tr><\/thead>
                  docker inspect my_container<\/code><\/td>Inspect a container<\/td><\/tr>
                  docker inspect nginx:latest<\/code><\/td>Inspect an image<\/td><\/tr>
                  docker inspect my_custom_network<\/code><\/td>Inspect a network<\/td><\/tr>
                  docker inspect my_data_volume<\/code><\/td>Inspect a volume<\/td><\/tr>
                  docker inspect -f '{{.State.Status}}' my_container<\/code><\/td>Show the container\u2019s status<\/td><\/tr>
                  docker inspect -f '{{.NetworkSettings.IPAddress}}' my_container<\/code><\/td>Show the container\u2019s IP address<\/td><\/tr>
                  docker inspect -f '{{.Config.Image}}' my_container<\/code><\/td>Show the base image used by the container<\/td><\/tr>
                  docker inspect -f '{{.HostConfig.Memory}}' my_container<\/code><\/td>Show the memory limit for the container<\/td><\/tr>
                  `docker inspect my_container<\/td>jq ‘.’`<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                  \n\n\n\n
                  Best Practices for Using docker inspect<\/code>:<\/strong><\/h2>\n\n\n\n
                    \n
                  1. Use --format<\/code> for specific data extraction<\/strong>, especially when scripting.<\/li>\n\n\n\n
                  2. Combine with jq<\/code><\/strong> for easier JSON processing and filtering.<\/li>\n\n\n\n
                  3. Automate checks<\/strong> using inspection data in CI\/CD pipelines.<\/li>\n\n\n\n
                  4. Monitor and audit images<\/strong> by inspecting their history and base image.<\/li>\n\n\n\n
                  5. Document important configuration details<\/strong> by saving the inspection output to a file.<\/li>\n<\/ol>\n\n\n\n
                    \n\n\n\n
                    Common Errors and Solutions<\/strong><\/h2>\n\n\n\n
                      \n
                    1. “No such object”<\/strong>
                      \u2192 Ensure the container, image, network, or volume exists. Use docker ps -a<\/code> or docker images<\/code> to verify.<\/li>\n\n\n\n
                    2. “Empty output for a field”<\/strong>
                      \u2192 The field may not exist for the inspected object. Check the full JSON output first.<\/li>\n\n\n\n
                    3. “JSON output too large”<\/strong>
                      \u2192 Use --format<\/code> to filter and reduce the output size.<\/li>\n<\/ol>\n\n\n\n
                      \n\n\n\n
                      Combining docker inspect<\/code> with Other Commands<\/strong><\/h2>\n\n\n\n
                      Monitor and Check Container Status<\/strong><\/h3>\n\n\n
                      docker ps -q | xargs -n 1<\/span> docker inspect -f '{{.Name}}: {{.State.Status}}'<\/span>\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
                      Validate and Log Container Configurations<\/strong><\/h3>\n\n\n
                      docker<\/span> inspect<\/span> my_app_container<\/span> > app_config<\/span>.json<\/span>\n<\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
                      \n\n\n\n
                      <\/p>\n","protected":false},"excerpt":{"rendered":"
                      Here\u2019s a complete tutorial on docker inspect, covering what it does, examples, and use cases. What is docker inspect? docker inspect is a Docker command that retrieves detailed information about… <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_joinchat":[],"footnotes":""},"categories":[4862],"tags":[],"class_list":["post-48442","post","type-post","status-publish","format-standard","hentry","category-docker"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/48442","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=48442"}],"version-history":[{"count":2,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/48442\/revisions"}],"predecessor-version":[{"id":48444,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/48442\/revisions\/48444"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=48442"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=48442"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=48442"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}