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 'List' operation, it retrieves a list of Docker networks based on optional filtering options provided as JSON. This is useful for scenarios where you need to programmatically manage or monitor Docker networks within an automation workflow, such as listing all available networks or filtering networks by specific criteria.

Use Case Examples

1. Listing all Docker networks to monitor network configurations.
2. Filtering Docker networks by specific options to manage network resources dynamically.

Properties

Output

JSON

• id - The unique identifier 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 - Containers connected to the Docker network.
• options - Additional options or settings of the Docker network.

Dependencies

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

Troubleshooting

• Ensure Docker credentials are correctly configured and accessible; missing credentials will cause the node to throw an error.
• The 'Options' property must be a valid JSON object; invalid JSON will cause parsing errors.
• Docker daemon must be running and accessible from the environment where the node executes.
• Common error: 'No credentials got returned!' indicates missing or misconfigured Docker credentials.
• If the node fails to list networks, verify Docker API permissions and network availability.

Links

• Docker API - Network List - Official Docker API documentation for listing networks, detailing available options and response structure.