Portainer icon

Portainer

Work with Portainer API data to manage Docker

Actions86

Edge Group → Create

AI-generated

Overview

This node operation creates a new edge computing group in Portainer. It allows users to define the group name, specify whether the group is dynamic (tag-based), and assign either tag IDs for dynamic groups or endpoint IDs for static groups. This is useful for managing and organizing edge computing resources efficiently within Portainer.

Use Case Examples

  1. Creating a dynamic edge group with specific tags to automatically include endpoints matching those tags.
  2. Creating a static edge group by specifying exact endpoint IDs to group specific edge devices.

Properties

Name Meaning
Edge Group Name Name of the edge computing group to be created.
Is Dynamic Boolean flag indicating whether the group is dynamic (tag-based) or static.
Tag IDs Comma-separated list of tag IDs used to define a dynamic group. Only applicable if 'Is Dynamic' is true.
Endpoint IDs Comma-separated list of endpoint IDs used to define a static group. Only applicable if 'Is Dynamic' is false.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • Name - The name of the created edge group.
  • Dynamic - Boolean indicating if the group is dynamic.
  • TagIds - Array of tag IDs associated with the dynamic group.
  • Endpoints - Array of endpoint IDs associated with the static group.

Dependencies

  • Portainer API with an API key credential for authentication

Troubleshooting

  • Ensure the API key credential is valid and has permissions to create edge groups.
  • Verify that the tag IDs and endpoint IDs are correctly formatted as comma-separated integers.
  • If the request fails due to SSL issues, consider enabling the 'Ignore SSL Issues' option or verify the SSL certificate.
  • Check the timeout setting if the request takes too long or times out.

Links

Discussion