Docker icon

Docker

Interact with Docker

Actions12

Overview

This node interacts with Docker to perform operations on Docker resources. Specifically, for the 'Network' resource with the 'Get' operation, it retrieves detailed information about a specific Docker network by its ID. This is useful for scenarios where you need to inspect network configurations, status, or metadata within a Docker environment, such as in container orchestration or monitoring workflows.

Use Case Examples

  1. Retrieve details of a Docker network by specifying its ID to monitor network settings or troubleshoot connectivity issues.
  2. Use the node to fetch network information as part of a larger automation that manages Docker resources dynamically.

Properties

Name Meaning
ID The unique identifier of the Docker network to retrieve information about.

Output

JSON

  • id - The ID of the Docker network.
  • name - The name of the Docker network.
  • driver - The network driver used by the Docker network.
  • scope - The scope of the Docker network (e.g., local, global).
  • containers - Details about containers connected to the network.
  • options - Additional options and configurations of the network.

Dependencies

  • Docker API access via dockerode library
  • An API key credential for Docker authentication

Troubleshooting

  • Ensure Docker daemon is running and accessible from the environment where the node executes.
  • Verify that the provided network ID is correct and exists in the Docker environment.
  • Check that the Docker credentials provided have sufficient permissions to access network information.
  • Common error: 'No credentials got returned!' indicates missing or misconfigured Docker API credentials.
  • Error related to volume mounts will not apply to the 'Get Network' operation but may appear if other operations are used incorrectly.

Discussion