Overview

This node interacts with Docker to perform various operations such as getting details, listing resources, and running containers. Specifically, for the 'Network' resource with the 'List' operation, it retrieves a list of Docker networks based on optional JSON filter options provided by the user. This is useful for scenarios where you need to programmatically manage or monitor Docker networks within an automation workflow, such as listing all 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 efficiently.

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 - Details about containers connected to the network.

Dependencies

• Docker API accessed via dockerode library
• Requires Docker API credentials

Troubleshooting

• Ensure Docker credentials are correctly configured; missing credentials will cause the node to throw an error 'No credentials got returned!'.
• The 'Options' property must be a valid JSON object; invalid JSON will cause parsing errors.
• If the Docker daemon is not accessible or running, the node will fail to list networks.
• Errors from Docker API calls will be propagated; check Docker daemon logs for more details.

Links

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