Overview

This node interacts with Docker to perform operations on Docker resources such as containers, images, volumes, and networks. 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 or manage Docker networks programmatically within an automation workflow, such as monitoring network configurations or integrating Docker network data into other systems.

Use Case Examples

1. Retrieve details of a Docker network by specifying its ID to monitor network settings.
2. Use the node to get network information as part of a larger workflow that manages Docker resources.

Properties

Output

JSON

• id - The ID of the Docker network.
• name - The name of the Docker network.
• driver - The driver used by the Docker network.
• scope - The scope of the Docker network.
• containers - Details about containers connected to the network.
• options - Options set for the Docker network.
• labels - Labels assigned to the Docker network.

Dependencies

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

Troubleshooting

• Ensure Docker credentials are correctly configured; missing or invalid credentials will cause the node to throw an error 'No credentials got returned!'.
• The 'ID' property must be a valid Docker network ID; otherwise, the Docker API call will fail.
• If the Docker daemon is not accessible or running, the node will fail to retrieve network information.

Links

• Docker Network Inspect API - Official Docker API documentation for inspecting networks, which this node utilizes.
• dockerode GitHub Repository - The Node.js Docker client library used by this node to interact with Docker.