Actions72
- Image Actions
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Stack Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
Overview
This node allows you to create a new Edge Group in Portainer, which is a management tool for Docker environments and edge computing resources. An Edge Group is a collection of edge endpoints that can be managed collectively. The group can be either static (with explicitly assigned endpoints) or dynamic (defined by tags).
Common scenarios where this node is useful include:
- Organizing edge devices/endpoints into groups for easier management and deployment.
- Creating dynamic groups based on tags to automatically include endpoints matching certain criteria.
- Automating the provisioning and grouping of edge resources in large distributed environments.
For example, you might create an Edge Group named "Factory Floor Devices" that dynamically includes all edge endpoints tagged with "factory-floor", or a static group "Remote Sensors" with specific endpoint IDs.
Properties
| Name | Meaning |
|---|---|
| Edge Group Name | The name of the edge group to create. |
| Is Dynamic | Boolean flag indicating if the group is dynamic (based on tags) or static (based on endpoints). |
| Tag IDs | Comma-separated list of tag IDs used to define a dynamic group. Required if "Is Dynamic" is true. |
| Endpoint IDs | Comma-separated list of endpoint IDs to include in a static group. Required if "Is Dynamic" is false. |
Output
The node outputs the JSON response from the Portainer API after creating the edge group. This typically includes details about the newly created edge group such as its ID, name, whether it is dynamic, associated tag IDs, and endpoint IDs.
No binary data output is involved.
Dependencies
- Requires an API key credential for authenticating with the Portainer API.
- The base URL of the Portainer instance must be configured in the credentials.
- The node sends a POST request to the
/edge_groupsendpoint of the Portainer API.
Troubleshooting
- Invalid or missing API key: Ensure the API key credential is correctly set up and has sufficient permissions.
- Incorrect base URL: Verify the Portainer base URL is correct and accessible.
- Malformed Tag IDs or Endpoint IDs: Provide valid comma-separated numeric IDs without extra spaces or invalid characters.
- Missing required fields: The "Edge Group Name" is mandatory; also, depending on the "Is Dynamic" flag, either "Tag IDs" or "Endpoint IDs" must be provided.
- API errors: If the Portainer API returns an error, check the message for details such as duplicate group names or invalid references.
Links and References
If you need further details or examples, feel free to ask!