FleetAppsManagementRunbooksClient¶
-
class
oci.fleet_apps_management.
FleetAppsManagementRunbooksClient
(config, **kwargs)¶ Fleet Application Management Service API. Use this API to for all FAMS related activities. To manage fleets,view complaince report for the Fleet,scedule patches and other lifecycle activities
Methods
__init__
(config, **kwargs)Creates a new service client get_runbook
(runbook_id, **kwargs)Gets a Runbook by identifier get_task_record
(task_record_id, **kwargs)Gets a TaskRecord by identifier list_runbooks
(**kwargs)Returns a list of Runbooks. list_task_records
(**kwargs)Returns a list of TaskRecords. -
__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, adict
can be passed. You can validate_config the dict usingvalidate_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 convenienceDEFAULT_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.
- config (dict) – Configuration keys and values as per SDK and Tool Configuration.
The
-
get_runbook
(runbook_id, **kwargs)¶ Gets a Runbook by identifier
Parameters: - runbook_id (str) – (required) Unique Runbook 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 usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. 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: Return type: Example: Click here to see an example of how to use get_runbook API.
-
get_task_record
(task_record_id, **kwargs)¶ Gets a TaskRecord by identifier
Parameters: - task_record_id (str) – (required) unique TaskDetail 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 usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. 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 typeTaskRecord
Return type: Example: Click here to see an example of how to use get_task_record API.
-
list_runbooks
(**kwargs)¶ Returns a list of Runbooks.
Parameters: - compartment_id (str) – (optional) The ID of the compartment in which to list resources.
- lifecycle_state (str) –
(optional) A filter to return only resources their lifecycleState matches the given lifecycleState.
Allowed values are: “ACTIVE”, “DELETED”, “FAILED”
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- id (str) – (optional) unique Runbook identifier
- type (str) –
(optional) The ID of the runbook type.
Allowed values are: “USER_DEFINED”, “ORACLE_DEFINED”, “SYSTEM_DEFINED”
- runbook_relevance (str) –
(optional) The runbook relevance of product or full-stack.
Allowed values are: “PRODUCT_GROUP”, “PRODUCT”
- platform (str) – (optional) The ID of the runbook platform.
- operation (str) – (optional) The runbook lifecycle.
- limit (int) – (optional) The maximum number of items to return.
- page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.
- 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.
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 usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. 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 typeRunbookCollection
Return type: Example: Click here to see an example of how to use list_runbooks API.
-
list_task_records
(**kwargs)¶ Returns a list of TaskRecords.
Parameters: - compartment_id (str) – (optional) The ID of the compartment in which to list resources.
- platform (str) – (optional) The platform for the Task.
- type (str) –
(optional) The type of the Task.
Allowed values are: “USER_DEFINED”, “ORACLE_DEFINED”, “SYSTEM_DEFINED”
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- id (str) – (optional) unique TaskDetail identifier
- limit (int) – (optional) The maximum number of items to return.
- page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.
- lifecycle_state (str) –
(optional) The current state of the Task.
Allowed values are: “ACTIVE”, “INACTIVE”, “DELETED”, “DELETING”, “FAILED”, “UPDATING”
- 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.
Allowed values are: “timeCreated”, “displayName”
- sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.
Allowed values are: “ASC”, “DESC”
- 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 usesDEFAULT_RETRY_STRATEGY
as default if no retry strategy is provided. 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 typeTaskRecordCollection
Return type: Example: Click here to see an example of how to use list_task_records API.
-