InstanceAgentCommand¶
- class oci.compute_instance_agent.models.InstanceAgentCommand(**kwargs)¶
Bases:
objectThe command payload.
Methods:
__init__(**kwargs)Initializes a new InstanceAgentCommand object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this InstanceAgentCommand.
[Required] Gets the content of this InstanceAgentCommand.
Gets the display_name of this InstanceAgentCommand.
Gets the execution_time_out_in_seconds of this InstanceAgentCommand.
[Required] Gets the id of this InstanceAgentCommand.
Gets the is_canceled of this InstanceAgentCommand.
[Required] Gets the target of this InstanceAgentCommand.
Gets the time_created of this InstanceAgentCommand.
Gets the time_updated of this InstanceAgentCommand.
- __init__(**kwargs)¶
Initializes a new InstanceAgentCommand object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this InstanceAgentCommand.
compartment_id (str) – The value to assign to the compartment_id property of this InstanceAgentCommand.
display_name (str) – The value to assign to the display_name property of this InstanceAgentCommand.
time_created (datetime) – The value to assign to the time_created property of this InstanceAgentCommand.
time_updated (datetime) – The value to assign to the time_updated property of this InstanceAgentCommand.
is_canceled (bool) – The value to assign to the is_canceled property of this InstanceAgentCommand.
execution_time_out_in_seconds (int) – The value to assign to the execution_time_out_in_seconds property of this InstanceAgentCommand.
target (oci.compute_instance_agent.models.InstanceAgentCommandTarget) – The value to assign to the target property of this InstanceAgentCommand.
content (oci.compute_instance_agent.models.InstanceAgentCommandContent) – The value to assign to the content property of this InstanceAgentCommand.
- property compartment_id¶
[Required] Gets the compartment_id of this InstanceAgentCommand. The OCID of the compartment containing the command.
- Returns
The compartment_id of this InstanceAgentCommand.
- Return type
str
- property content¶
[Required] Gets the content of this InstanceAgentCommand. The contents of the command.
- Returns
The content of this InstanceAgentCommand.
- Return type
oci.compute_instance_agent.models.InstanceAgentCommandContent
- property display_name¶
Gets the display_name of this InstanceAgentCommand. A user-friendly name. Does not have to be unique. Avoid entering confidential information.
- Returns
The display_name of this InstanceAgentCommand.
- Return type
str
- property execution_time_out_in_seconds¶
Gets the execution_time_out_in_seconds of this InstanceAgentCommand. The amount of time that Oracle Cloud Agent is given to run the command on the instance before timing out. The timer starts when Oracle Cloud Agent starts the command. Zero means no timeout.
- Returns
The execution_time_out_in_seconds of this InstanceAgentCommand.
- Return type
int
- property id¶
[Required] Gets the id of this InstanceAgentCommand. The OCID of the command.
- Returns
The id of this InstanceAgentCommand.
- Return type
str
- property is_canceled¶
Gets the is_canceled of this InstanceAgentCommand. Whether a request was made to cancel the command. Canceling a command is a best-effort attempt.
- Returns
The is_canceled of this InstanceAgentCommand.
- Return type
bool
- property target¶
[Required] Gets the target of this InstanceAgentCommand. The target instance that the command runs on.
- Returns
The target of this InstanceAgentCommand.
- Return type
oci.compute_instance_agent.models.InstanceAgentCommandTarget