ManagementAgentClient¶

class oci.management_agent.ManagementAgentClient(config, **kwargs)¶

Use the Management Agent API to manage your infrastructure’s management agents, including their plugins and install keys. For more information, see [Management Agent](https://docs.cloud.oracle.com/iaas/management-agents/index.html).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`create_data_source`(management_agent_id, …)	Datasource creation request to given Management Agent.
`create_management_agent_install_key`(…)	User creates a new install key as part of this API.
`delete_data_source`(management_agent_id, …)	Datasource delete request to given Management Agent.
`delete_management_agent`(management_agent_id, …)	Deletes a Management Agent resource by identifier
`delete_management_agent_install_key`(…)	Deletes a Management Agent install Key resource by identifier
`delete_work_request`(work_request_id, **kwargs)	Cancel the work request with the given ID.
`deploy_plugins`(deploy_plugins_details, **kwargs)	Deploys Plugins to a given list of agentIds.
`get_auto_upgradable_config`(compartment_id, …)	Get the AutoUpgradable configuration for all agents in a tenancy.
`get_data_source`(management_agent_id, …)	Get Datasource details for given Id and given Management Agent.
`get_management_agent`(management_agent_id, …)	Gets complete details of the inventory of a given agent id
`get_management_agent_install_key`(…)	Gets complete details of the Agent install Key for a given key id
`get_management_agent_install_key_content`(…)	Returns a file with Management Agent install Key in it
`get_work_request`(work_request_id, **kwargs)	Gets the status of the work request with the given ID.
`list_availability_histories`(…)	Lists the availability history records of Management Agent
`list_data_sources`(management_agent_id, **kwargs)	A list of Management Agent Data Sources for the given Management Agent Id.
`list_management_agent_images`(compartment_id, …)	Get supported agent image information
`list_management_agent_install_keys`(…)	Returns a list of Management Agent installed Keys.
`list_management_agent_plugins`(…)	Returns a list of managementAgentPlugins.
`list_management_agents`(compartment_id, **kwargs)	Returns a list of Management Agents.
`list_work_request_errors`(work_request_id, …)	Return a (paginated) list of errors for a given work request.
`list_work_request_logs`(work_request_id, **kwargs)	Return a (paginated) list of logs for a given work request.
`list_work_requests`(compartment_id, **kwargs)	Lists the work requests in a compartment.
`set_auto_upgradable_config`(…)	Sets the AutoUpgradable configuration for all agents in a tenancy.
`summarize_management_agent_counts`(…)	Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters.
`summarize_management_agent_plugin_counts`(…)	Gets count of the inventory of management agent plugins for a given compartment id and group by parameter.
`update_data_source`(management_agent_id, …)	Datasource update request to given Management Agent.
`update_management_agent`(management_agent_id, …)	API to update the console managed properties of the Management Agent.
`update_management_agent_install_key`(…)	API to update the modifiable properties of the Management Agent install key.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

create_data_source(management_agent_id, create_data_source_details, **kwargs)¶

Datasource creation request to given Management Agent.

Parameters:	management_agent_id (str) – (required) Unique Management Agent identifier create_data_source_details (oci.management_agent.models.CreateDataSourceDetails) – (required) Details of DataSource to be created for the given Management Agent. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use create_data_source API.

create_management_agent_install_key(create_management_agent_install_key_details, **kwargs)¶

User creates a new install key as part of this API.

Parameters:	create_management_agent_install_key_details (oci.management_agent.models.CreateManagementAgentInstallKeyDetails) – (required) Details of the Agent install Key opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagementAgentInstallKey`
Return type:	`Response`
Example:

Click here to see an example of how to use create_management_agent_install_key API.

delete_data_source(management_agent_id, data_source_key, **kwargs)¶

Datasource delete request to given Management Agent.

Parameters:	management_agent_id (str) – (required) Unique Management Agent identifier data_source_key (str) – (required) Data source type and name identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_data_source API.

delete_management_agent(management_agent_id, **kwargs)¶

Deletes a Management Agent resource by identifier

Parameters:	management_agent_id (str) – (required) Unique Management Agent identifier if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_management_agent API.

delete_management_agent_install_key(management_agent_install_key_id, **kwargs)¶

Deletes a Management Agent install Key resource by identifier

Parameters:	management_agent_install_key_id (str) – (required) Unique Management Agent Install Key identifier if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_management_agent_install_key API.

delete_work_request(work_request_id, **kwargs)¶

Cancel the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_work_request API.

deploy_plugins(deploy_plugins_details, **kwargs)¶

Deploys Plugins to a given list of agentIds.

Parameters:	deploy_plugins_details (oci.management_agent.models.DeployPluginsDetails) – (required) Details of Plugins to be deployed for a given list of Management Agents. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use deploy_plugins API.

get_auto_upgradable_config(compartment_id, **kwargs)¶

Get the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.

Parameters:	compartment_id (str) – (required) The OCID of the compartment to which a request will be scoped. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AutoUpgradableConfig`
Return type:	`Response`
Example:

Click here to see an example of how to use get_auto_upgradable_config API.

get_data_source(management_agent_id, data_source_key, **kwargs)¶

Get Datasource details for given Id and given Management Agent.

Parameters:	management_agent_id (str) – (required) Unique Management Agent identifier data_source_key (str) – (required) Data source type and name identifier. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataSource`
Return type:	`Response`
Example:

Click here to see an example of how to use get_data_source API.

get_management_agent(management_agent_id, **kwargs)¶

Gets complete details of the inventory of a given agent id

Parameters:	management_agent_id (str) – (required) Unique Management Agent identifier opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagementAgent`
Return type:	`Response`
Example:

Click here to see an example of how to use get_management_agent API.

get_management_agent_install_key(management_agent_install_key_id, **kwargs)¶

Gets complete details of the Agent install Key for a given key id

Parameters:	management_agent_install_key_id (str) – (required) Unique Management Agent Install Key identifier opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagementAgentInstallKey`
Return type:	`Response`
Example:

Click here to see an example of how to use get_management_agent_install_key API.

get_management_agent_install_key_content(management_agent_install_key_id, **kwargs)¶

Returns a file with Management Agent install Key in it

Parameters:	management_agent_install_key_id (str) – (required) Unique Management Agent Install Key identifier opc_request_id (str) – (optional) The client request ID for tracing. plugin_name (list[str]) – (optional) Filter to return input plugin names uncommented in the output. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type stream
Return type:	`Response`
Example:

Click here to see an example of how to use get_management_agent_install_key_content API.

get_work_request(work_request_id, **kwargs)¶

Gets the status of the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use get_work_request API.

list_availability_histories(management_agent_id, **kwargs)¶

Lists the availability history records of Management Agent

Parameters:	management_agent_id (str) – (required) Unique Management Agent identifier opc_request_id (str) – (optional) The client request ID for tracing. time_availability_status_ended_greater_than (datetime) – (optional) Filter to limit the availability history results to that of time after the input time including the boundary record. Defaulted to current date minus one year. The date and time to be given as described in RFC 3339, section 5.6. time_availability_status_started_less_than (datetime) – (optional) Filter to limit the availability history results to that of time before the input time including the boundary record Defaulted to current date. The date and time to be given as described in RFC 3339, section 5.6. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Default order for timeAvailabilityStatusStarted is descending. Allowed values are: “timeAvailabilityStatusStarted” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `AvailabilityHistorySummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_availability_histories API.

list_data_sources(management_agent_id, **kwargs)¶

A list of Management Agent Data Sources for the given Management Agent Id.

Parameters:	management_agent_id (str) – (required) Unique Management Agent identifier opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. If no value is specified dataSourceName is default. Allowed values are: “dataSourceName”, “dataSourceType” name (list[str]) – (optional) Unique name of the dataSource. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `DataSourceSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_data_sources API.

list_management_agent_images(compartment_id, **kwargs)¶

Get supported agent image information

Parameters:	compartment_id (str) – (required) The OCID of the compartment to which a request will be scoped. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for platformType is descending. Default order for version is descending. If no value is specified platformType is default. Allowed values are: “platformType”, “version” name (str) – (optional) A filter to return only resources that match the entire platform name given. lifecycle_state (str) – (optional) Filter to return only Management Agents in the particular lifecycle state. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “TERMINATED”, “DELETING”, “DELETED”, “FAILED” install_type (str) – (optional) A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned. Allowed values are: “AGENT”, “GATEWAY” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ManagementAgentImageSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_management_agent_images API.

list_management_agent_install_keys(compartment_id, **kwargs)¶

Returns a list of Management Agent installed Keys.

Parameters:	compartment_id (str) – (required) The OCID of the compartment to which a request will be scoped. compartment_id_in_subtree (bool) – (optional) if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified. access_level (str) – (optional) Value of this is always “ACCESSIBLE” and any other value is not supported. lifecycle_state (str) – (optional) Filter to return only Management Agents in the particular lifecycle state. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “TERMINATED”, “DELETING”, “DELETED”, “FAILED” display_name (str) – (optional) The display name for which the Key needs to be listed. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ManagementAgentInstallKeySummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_management_agent_install_keys API.

list_management_agent_plugins(compartment_id, **kwargs)¶

Returns a list of managementAgentPlugins.

Parameters:	compartment_id (str) – (required) The OCID of the compartment to which a request will be scoped. display_name (str) – (optional) Filter to return only Management Agent Plugins having the particular display name. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Default order for displayName is ascending. If no value is specified displayName is default. Allowed values are: “displayName” opc_request_id (str) – (optional) The client request ID for tracing. lifecycle_state (str) – (optional) Filter to return only Management Agents in the particular lifecycle state. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “TERMINATED”, “DELETING”, “DELETED”, “FAILED” platform_type (list[str]) – (optional) Filter to return only results having the particular platform type. Allowed values are: “LINUX”, “WINDOWS”, “SOLARIS”, “MACOSX” agent_id (str) – (optional) The ManagementAgentID of the agent from which the Management Agents to be filtered. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ManagementAgentPluginSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_management_agent_plugins API.

list_management_agents(compartment_id, **kwargs)¶

Returns a list of Management Agents. If no explicit page size limit is specified, it will default to 1000 when compartmentIdInSubtree is true and 5000 otherwise. The response is limited to maximum 1000 records when compartmentIdInSubtree is true.

Parameters:	compartment_id (str) – (required) The OCID of the compartment to which a request will be scoped. plugin_name (list[str]) – (optional) Filter to return only Management Agents having the particular Plugin installed. A special pluginName of ‘None’ can be provided and this will return only Management Agents having no plugin installed. version (list[str]) – (optional) Filter to return only Management Agents having the particular agent version. display_name (str) – (optional) Filter to return only Management Agents having the particular display name. lifecycle_state (str) – (optional) Filter to return only Management Agents in the particular lifecycle state. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “TERMINATED”, “DELETING”, “DELETED”, “FAILED” availability_status (str) – (optional) Filter to return only Management Agents in the particular availability status. Allowed values are: “ACTIVE”, “SILENT”, “NOT_AVAILABLE” host_id (str) – (optional) Filter to return only Management Agents having the particular agent host id. platform_type (list[str]) – (optional) Filter to return only results having the particular platform type. Allowed values are: “LINUX”, “WINDOWS”, “SOLARIS”, “MACOSX” is_customer_deployed (bool) – (optional) true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent. install_type (str) – (optional) A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned. Allowed values are: “AGENT”, “GATEWAY” gateway_id (list[str]) – (optional) Filter to return only results having the particular gatewayId. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName”, “host”, “availabilityStatus”, “platformType”, “pluginDisplayNames”, “version” opc_request_id (str) – (optional) The client request ID for tracing. compartment_id_in_subtree (bool) – (optional) if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified. access_level (str) – (optional) When the value is “ACCESSIBLE”, insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request. data_source_type (str) – (optional) The type of the dataSource. Allowed values are: “KUBERNETES_CLUSTER”, “PROMETHEUS_EMITTER” data_source_name (list[str]) – (optional) Unique name of the dataSource. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ManagementAgentSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_management_agents API.

list_work_request_errors(work_request_id, **kwargs)¶

Return a (paginated) list of errors for a given work request.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may Allowed values are: “timestamp” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestError`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)¶

Return a (paginated) list of logs for a given work request.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may Allowed values are: “timestamp” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestLogEntry`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(compartment_id, **kwargs)¶

Lists the work requests in a compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment to which a request will be scoped. agent_id (str) – (optional) The ManagementAgentID of the agent from which the Management Agents to be filtered. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. status (str) – (optional) The OperationStatus of the workRequest Allowed values are: “CREATED”, “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED” type (list[str]) – (optional) The OperationType of the workRequest Allowed values are: “DEPLOY_PLUGIN”, “UPGRADE_PLUGIN”, “CREATE_UPGRADE_PLUGINS”, “AGENTIMAGE_UPGRADE”, “CREATE_DATA_SOURCE”, “UPDATE_DATA_SOURCE”, “DELETE_DATA_SOURCE” time_created_greater_than_or_equal_to (datetime) – (optional) Filter for items with timeCreated greater or equal to provided value. given timeCreatedGreaterThanOrEqualTo to the current time, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. If no value is specified timeAccepted is default. Allowed values are: “timeAccepted” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_requests API.

set_auto_upgradable_config(set_auto_upgradable_config_details, **kwargs)¶

Sets the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.

Parameters:	set_auto_upgradable_config_details (oci.management_agent.models.SetAutoUpgradableConfigDetails) – (required) Details of the AutoUpgradable configuration for agents of the tenancy. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AutoUpgradableConfig`
Return type:	`Response`
Example:

Click here to see an example of how to use set_auto_upgradable_config API.

summarize_management_agent_counts(compartment_id, group_by, **kwargs)¶

Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters. Supported groupBy parameters: availabilityStatus, platformType, version

Parameters:	compartment_id (str) – (required) The OCID of the compartment to which a request will be scoped. group_by (oci.management_agent.models.list[str]) – (required) The field by which to group Management Agents. Currently, only one groupBy dimension is supported at a time. Allowed values are: “availabilityStatus”, “platformType”, “version” has_plugins (bool) – (optional) When set to true then agents that have at least one plugin deployed will be returned. When set to false only agents that have no plugins deployed will be returned. install_type (str) – (optional) A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned. Allowed values are: “AGENT”, “GATEWAY” compartment_id_in_subtree (bool) – (optional) if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagementAgentAggregationCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use summarize_management_agent_counts API.

summarize_management_agent_plugin_counts(compartment_id, group_by, **kwargs)¶

Gets count of the inventory of management agent plugins for a given compartment id and group by parameter. Supported groupBy parameter: pluginName

Parameters:	compartment_id (str) – (required) The OCID of the compartment to which a request will be scoped. group_by (str) – (required) The field by which to group Management Agent Plugins Allowed values are: “pluginName” compartment_id_in_subtree (bool) – (optional) if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagementAgentPluginAggregationCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use summarize_management_agent_plugin_counts API.

update_data_source(management_agent_id, data_source_key, update_data_source_details, **kwargs)¶

Datasource update request to given Management Agent.

Parameters:	management_agent_id (str) – (required) Unique Management Agent identifier data_source_key (str) – (required) Data source type and name identifier. update_data_source_details (oci.management_agent.models.UpdateDataSourceDetails) – (required) Details of DataSource to be update for the given Management Agent. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_data_source API.

update_management_agent(management_agent_id, update_management_agent_details, **kwargs)¶

API to update the console managed properties of the Management Agent.

Parameters:	management_agent_id (str) – (required) Unique Management Agent identifier update_management_agent_details (oci.management_agent.models.UpdateManagementAgentDetails) – (required) Details required for changing the console managed properties of the Management Agent. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagementAgent`
Return type:	`Response`
Example:

Click here to see an example of how to use update_management_agent API.

update_management_agent_install_key(management_agent_install_key_id, update_management_agent_install_key_details, **kwargs)¶

API to update the modifiable properties of the Management Agent install key.

Parameters:	management_agent_install_key_id (str) – (required) Unique Management Agent Install Key identifier update_management_agent_install_key_details (oci.management_agent.models.UpdateManagementAgentInstallKeyDetails) – (required) Details required for changing the modifiable properties of the Management Agent install key. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagementAgentInstallKey`
Return type:	`Response`
Example:

Click here to see an example of how to use update_management_agent_install_key API.