You can generate a preview before performing the actual configuration change.
The preview tells you:
The request consumes an application/json
payload.
POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/oneagents/remoteConfigurationManagement/preview |
Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/preview |
To execute this request, you need an access token with oneAgents.write
scope.
To learn how to obtain and use it, see Tokens and authentication.
JSON body of the request, containing remote configuration management job definition.
RemoteConfigurationManagementOperationOneAgentRequest
objectRemote configuration management operation creation request.
A list of entities IDs for which remote configuration management is to be executed.
A list of remote configuration management operations to be executed.
RemoteConfigurationManagementOperation
objectDefinition of a single remote configuration management operation.
The attribute which is affected by the operation.
group
hostGroup
hostProperty
hostTag
networkZone
The operation performed on given attribute.
clear
set
The value which should be assigned to given attribute.
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"entities": ["HOST-D454A967666E7970","HOST-811760CFF2A5E872"],"operations": [{"attribute": "networkZone","operation": "set","value": "exampleNetworkZoneName"}]}
Endpoint was executed for not supported operation type
RemoteConfigurationManagementPreviewList
objectA list of remote configuration management jobs previews.
A list of remote configuration management jobs previews.
RemoteConfigurationManagementJobPreview
objectA preview of remote configuration management job.
The number of entities that are currently configured as defined by remote configuration management operation.
The attribute which is affected by the operation.
group
hostGroup
hostProperty
hostTag
networkZone
The operation performed on given attribute.
clear
set
The number of entities that will be configured as defined by remote configuration management after it is completed.
The value which should be assigned to given attribute.
{"previews": [{"alreadyConfiguredEntitiesCount": 1,"attribute": "networkZone","operation": "set","targetEntitiesCount": 2,"value": "exampleNetworkZoneName"}]}