Illumio Update Workload
Illumio Update Workload updates workloads for:
- Assets returned by the selected query or assets selected on the relevant asset page.
See Creating Enforcement Sets to learn more about adding Enforcement Actions to Enforcement Sets.
Required Fields
These fields must be configured to run the Enforcement Set.
- Action name - The name of this Enforcement Action. The system sets a default name. You can change the name.
- Configure Dynamic Values (optional) - Toggle on to enter a Dynamic Value statement. See Creating Enforcement Action Dynamic Value Statements to learn more about Dynamic Value statement syntax.
-
Use stored credentials from the Illumio Core adapter - Select this option to use credentials from the adapter connection. By default, the first connection is selected.
-
When you select this option, the Select Adapter Connection drop-down becomes available. Select the adapter connection to use for this Enforcement Action.
Note
To use this option, you must successfully configure an Illumio Core adapter connection.
-
-
Compute Node - The Axonius node to use when connecting to the specified host. For more details, see Working with Axonius Compute Nodes.
Additional Fields
These fields are optional.
-
Additional fields - Specify additional fields to be added as key/value pairs in a JSON format.
For example:{"field1": "value1", "field2": "value2"}If one of the specified fields is invalid, the request might fail.
-
Map Axonius fields to adapter fields - Use the Field Mapping Wizard to map Axonius fields to fields in external systems. In this way, you can transfer data found in Axonius into the external system as part of the configuration of relevant enforcement actions. The wizard shows you which fields exist on the Axonius system, allowing you to map them easily.
NoteFor details, see Axonius to External Field Mapping.
-
Labels to merge (KEY=VALUE) - Enter one or more labels in
KEY=VALUEformat, such asenv=Production, to update or add labels without replacing the other labels on the workload. Each value can be a literal, or it can include an Axonius field placeholder mapped through Map Axonius fields to adapter fields.- The label must already be defined in Illumio.
- The action updates only the label keys that you enter. All other existing labels on the workload, including custom label types, are kept.
- Each label key can appear only once, and every entry must use the
KEY=VALUEformat. Otherwise, the action does not update the workload. - If a label does not exist in Illumio, the action reports the missing
KEY=VALUEpair and does not update that workload. - Leave this field empty to keep the existing behavior, in which a
labelsvalue in Additional fields replaces the labels list of the workload. - Do not use this field together with a
labelsvalue in Additional fields or in Map Axonius fields to adapter fields. The action rejects this configuration.
Connection and CredentialsWhen Use stored credentials from the adapter is toggled off, some of the connection fields below are required to create the connection, while other fields are optional.
Host Name or IP Address (required) - The hostname or IP address of the Illumio Core server that Axonius can communicate with via the Required Ports.
Port - The port for connection. The default is 8443.
Authentication User Name (required) - The credentials for a user account that has Permissions to fetch assets. This is a randomized name generated when a user creates an API key.
API Secret (required) - An API Key associated with a user account that has Permissions to fetch assets.
Organization ID (required) - Auto generated when the API Secret is created.
Verify SSL (Optional) (default: enabled) - Selects whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings. This setting is enabled by default on all new adapter settings. If you need to disable SSL verification, make sure you disable this setting.)
HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.
HTTPS Proxy User Name (optional) - The user name to use when connecting to the server using the HTTPS Proxy.
HTTPS Proxy Password (optional) - The password to use when connecting to the server using the HTTPS Proxy.
-
Gateway Name - Select the Gateway through which to connect to perform the action.
APIs
Axonius uses the Illumio Core 24.5.0 - Create a Workload REST API.
When you use Labels to merge (KEY=VALUE), the action also calls the following endpoints:
GET /orgs/{org_id}/workloads/{workload_id}- Retrieves the current labels of the workload from Illumio. The action reads the labels at run time, not from the last fetch. After the update, the action reads the workload again to check the resulting labels.GET /orgs/{org_id}/labels- Retrieves the labels defined in Illumio, to match eachKEY=VALUEpair to an existing label.PUT /orgs/{org_id}/workloads/{workload_id}- Updates the workload with the merged labels.
Required Permissions
The API key must have the following permissions configured in Illumio to use this action:
- Workload write access - Permission to update workloads via the REST API
- Organization access - Valid access to the specified Organization ID
- Appropriate role assignment - Owner, Workload Manager, or a custom role with workload write permissions
- Label scope access - Either unscoped (full organization access) or scoped to specific labels where workloads will be updated
- Recommended Role: Workload Manager or Owner role for service account-based API keys.
For more details about other enforcement actions available, see Action Library.
Updated 13 days ago
