ManagementStation¶

class oci.os_management_hub.models.ManagementStation(**kwargs)¶

Bases: object

Provides information about the management station, including name, state, and configuration.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ManagementStation.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ManagementStation.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ManagementStation.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ManagementStation.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ManagementStation.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ManagementStation.
`LOCATION_AZURE`	A constant which can be used with the location property of a ManagementStation.
`LOCATION_EC2`	A constant which can be used with the location property of a ManagementStation.
`LOCATION_GCP`	A constant which can be used with the location property of a ManagementStation.
`LOCATION_OCI_COMPUTE`	A constant which can be used with the location property of a ManagementStation.
`LOCATION_ON_PREMISE`	A constant which can be used with the location property of a ManagementStation.
`OVERALL_STATE_ERROR`	A constant which can be used with the overall_state property of a ManagementStation.
`OVERALL_STATE_NORMAL`	A constant which can be used with the overall_state property of a ManagementStation.
`OVERALL_STATE_REGISTRATIONERROR`	A constant which can be used with the overall_state property of a ManagementStation.
`OVERALL_STATE_SYNCFAILED`	A constant which can be used with the overall_state property of a ManagementStation.
`OVERALL_STATE_SYNCING`	A constant which can be used with the overall_state property of a ManagementStation.
`OVERALL_STATE_UNAVAILABLE`	A constant which can be used with the overall_state property of a ManagementStation.
`OVERALL_STATE_WARNING`	A constant which can be used with the overall_state property of a ManagementStation.
`compartment_id`	[Required] Gets the compartment_id of this ManagementStation.
`defined_tags`	Gets the defined_tags of this ManagementStation.
`description`	Gets the description of this ManagementStation.
`display_name`	[Required] Gets the display_name of this ManagementStation.
`freeform_tags`	Gets the freeform_tags of this ManagementStation.
`health`	Gets the health of this ManagementStation.
`hostname`	[Required] Gets the hostname of this ManagementStation.
`id`	[Required] Gets the id of this ManagementStation.
`is_auto_config_enabled`	Gets the is_auto_config_enabled of this ManagementStation.
`lifecycle_state`	Gets the lifecycle_state of this ManagementStation.
`location`	Gets the location of this ManagementStation.
`managed_instance_id`	Gets the managed_instance_id of this ManagementStation.
`mirror`	[Required] Gets the mirror of this ManagementStation.
`mirror_capacity`	Gets the mirror_capacity of this ManagementStation.
`mirror_package_count`	Gets the mirror_package_count of this ManagementStation.
`mirror_size`	Gets the mirror_size of this ManagementStation.
`mirror_storage_available_size`	Gets the mirror_storage_available_size of this ManagementStation.
`mirror_storage_size`	Gets the mirror_storage_size of this ManagementStation.
`mirror_sync_status`	Gets the mirror_sync_status of this ManagementStation.
`mirror_unique_package_count`	Gets the mirror_unique_package_count of this ManagementStation.
`overall_percentage`	Gets the overall_percentage of this ManagementStation.
`overall_state`	Gets the overall_state of this ManagementStation.
`peer_management_stations`	[Required] Gets the peer_management_stations of this ManagementStation.
`profile_id`	Gets the profile_id of this ManagementStation.
`proxy`	[Required] Gets the proxy of this ManagementStation.
`scheduled_job_id`	Gets the scheduled_job_id of this ManagementStation.
`system_tags`	Gets the system_tags of this ManagementStation.
`total_mirrors`	Gets the total_mirrors of this ManagementStation.

Methods

__init__(**kwargs) Initializes a new ManagementStation object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ManagementStation. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ManagementStation. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ManagementStation. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ManagementStation. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ManagementStation. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ManagementStation. This constant has a value of “UPDATING”

LOCATION_AZURE = 'AZURE'¶: A constant which can be used with the location property of a ManagementStation. This constant has a value of “AZURE”

LOCATION_EC2 = 'EC2'¶: A constant which can be used with the location property of a ManagementStation. This constant has a value of “EC2”

LOCATION_GCP = 'GCP'¶: A constant which can be used with the location property of a ManagementStation. This constant has a value of “GCP”

LOCATION_OCI_COMPUTE = 'OCI_COMPUTE'¶: A constant which can be used with the location property of a ManagementStation. This constant has a value of “OCI_COMPUTE”

LOCATION_ON_PREMISE = 'ON_PREMISE'¶: A constant which can be used with the location property of a ManagementStation. This constant has a value of “ON_PREMISE”

OVERALL_STATE_ERROR = 'ERROR'¶: A constant which can be used with the overall_state property of a ManagementStation. This constant has a value of “ERROR”

OVERALL_STATE_NORMAL = 'NORMAL'¶: A constant which can be used with the overall_state property of a ManagementStation. This constant has a value of “NORMAL”

OVERALL_STATE_REGISTRATIONERROR = 'REGISTRATIONERROR'¶: A constant which can be used with the overall_state property of a ManagementStation. This constant has a value of “REGISTRATIONERROR”

OVERALL_STATE_SYNCFAILED = 'SYNCFAILED'¶: A constant which can be used with the overall_state property of a ManagementStation. This constant has a value of “SYNCFAILED”

OVERALL_STATE_SYNCING = 'SYNCING'¶: A constant which can be used with the overall_state property of a ManagementStation. This constant has a value of “SYNCING”

OVERALL_STATE_UNAVAILABLE = 'UNAVAILABLE'¶: A constant which can be used with the overall_state property of a ManagementStation. This constant has a value of “UNAVAILABLE”

OVERALL_STATE_WARNING = 'WARNING'¶: A constant which can be used with the overall_state property of a ManagementStation. This constant has a value of “WARNING”

__init__(**kwargs)¶

Initializes a new ManagementStation 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 ManagementStation.
managed_instance_id (str) – The value to assign to the managed_instance_id property of this ManagementStation.
compartment_id (str) – The value to assign to the compartment_id property of this ManagementStation.
scheduled_job_id (str) – The value to assign to the scheduled_job_id property of this ManagementStation.
profile_id (str) – The value to assign to the profile_id property of this ManagementStation.
display_name (str) – The value to assign to the display_name property of this ManagementStation.
description (str) – The value to assign to the description property of this ManagementStation.
hostname (str) – The value to assign to the hostname property of this ManagementStation.
overall_state (str) – The value to assign to the overall_state property of this ManagementStation. Allowed values for this property are: “NORMAL”, “REGISTRATIONERROR”, “SYNCING”, “SYNCFAILED”, “WARNING”, “ERROR”, “UNAVAILABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
overall_percentage (int) – The value to assign to the overall_percentage property of this ManagementStation.
mirror_capacity (int) – The value to assign to the mirror_capacity property of this ManagementStation.
total_mirrors (int) – The value to assign to the total_mirrors property of this ManagementStation.
mirror_sync_status (oci.os_management_hub.models.MirrorSyncStatus) – The value to assign to the mirror_sync_status property of this ManagementStation.
proxy (oci.os_management_hub.models.ProxyConfiguration) – The value to assign to the proxy property of this ManagementStation.
mirror (oci.os_management_hub.models.MirrorConfiguration) – The value to assign to the mirror property of this ManagementStation.
health (oci.os_management_hub.models.StationHealth) – The value to assign to the health property of this ManagementStation.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ManagementStation. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_auto_config_enabled (bool) – The value to assign to the is_auto_config_enabled property of this ManagementStation.
peer_management_stations (list[oci.os_management_hub.models.PeerManagementStation]) – The value to assign to the peer_management_stations property of this ManagementStation.
location (str) – The value to assign to the location property of this ManagementStation. Allowed values for this property are: “ON_PREMISE”, “OCI_COMPUTE”, “AZURE”, “EC2”, “GCP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
mirror_storage_available_size (int) – The value to assign to the mirror_storage_available_size property of this ManagementStation.
mirror_storage_size (int) – The value to assign to the mirror_storage_size property of this ManagementStation.
mirror_size (int) – The value to assign to the mirror_size property of this ManagementStation.
mirror_unique_package_count (int) – The value to assign to the mirror_unique_package_count property of this ManagementStation.
mirror_package_count (int) – The value to assign to the mirror_package_count property of this ManagementStation.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ManagementStation.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ManagementStation.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ManagementStation.

compartment_id¶

[Required] Gets the compartment_id of this ManagementStation. The OCID of the compartment that contains the management station.

Returns:	The compartment_id of this ManagementStation.
Return type:	str

defined_tags¶

Gets the defined_tags of this ManagementStation. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this ManagementStation.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this ManagementStation. User-specified description for the management station.

Returns:	The description of this ManagementStation.
Return type:	str

display_name¶

[Required] Gets the display_name of this ManagementStation. A user-friendly name for the management station.

Returns:	The display_name of this ManagementStation.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ManagementStation. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this ManagementStation.
Return type:	dict(str, str)

health¶

Gets the health of this ManagementStation.

Returns:	The health of this ManagementStation.
Return type:	oci.os_management_hub.models.StationHealth

hostname¶

[Required] Gets the hostname of this ManagementStation. Hostname of the management station.

Returns:	The hostname of this ManagementStation.
Return type:	str

id¶

[Required] Gets the id of this ManagementStation. The OCID of the management station.

Returns:	The id of this ManagementStation.
Return type:	str

is_auto_config_enabled¶

Gets the is_auto_config_enabled of this ManagementStation. When enabled, the station setup script automatically runs to configure the firewall and SELinux settings on the station.

Returns:	The is_auto_config_enabled of this ManagementStation.
Return type:	bool

lifecycle_state¶

Gets the lifecycle_state of this ManagementStation. The current state of the management station.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this ManagementStation.
Return type:	str

location¶

Gets the location of this ManagementStation. The location of the instance that is acting as the management station.

Allowed values for this property are: “ON_PREMISE”, “OCI_COMPUTE”, “AZURE”, “EC2”, “GCP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The location of this ManagementStation.
Return type:	str

managed_instance_id¶

Gets the managed_instance_id of this ManagementStation. The OCID of the instance that is acting as the management station.

Returns:	The managed_instance_id of this ManagementStation.
Return type:	str

mirror¶

[Required] Gets the mirror of this ManagementStation.

Returns:	The mirror of this ManagementStation.
Return type:	oci.os_management_hub.models.MirrorConfiguration

mirror_capacity¶

Gets the mirror_capacity of this ManagementStation. A decimal number representing the amount of mirror capacity used by the sync.

Returns:	The mirror_capacity of this ManagementStation.
Return type:	int

mirror_package_count¶

Gets the mirror_package_count of this ManagementStation. The total number of all packages within the mirrored software sources.

Returns:	The mirror_package_count of this ManagementStation.
Return type:	int

mirror_size¶

Gets the mirror_size of this ManagementStation. The total size of all software source mirrors in bytes.

Returns:	The mirror_size of this ManagementStation.
Return type:	int

mirror_storage_available_size¶

Gets the mirror_storage_available_size of this ManagementStation. Amount of available mirror storage in bytes.

Returns:	The mirror_storage_available_size of this ManagementStation.
Return type:	int

mirror_storage_size¶

Gets the mirror_storage_size of this ManagementStation. Total mirror storage size in bytes.

Returns:	The mirror_storage_size of this ManagementStation.
Return type:	int

mirror_sync_status¶

Gets the mirror_sync_status of this ManagementStation.

Returns:	The mirror_sync_status of this ManagementStation.
Return type:	oci.os_management_hub.models.MirrorSyncStatus

mirror_unique_package_count¶

Gets the mirror_unique_package_count of this ManagementStation. The total number of unique packages within the mirrored software sources on the station. Each package is counted only once, regardless of how many versions it has.

Returns:	The mirror_unique_package_count of this ManagementStation.
Return type:	int

overall_percentage¶

Gets the overall_percentage of this ManagementStation. A decimal number representing the progress of the current mirror sync.

Returns:	The overall_percentage of this ManagementStation.
Return type:	int

overall_state¶

Gets the overall_state of this ManagementStation. Current state of the mirror sync for the management station.

Allowed values for this property are: “NORMAL”, “REGISTRATIONERROR”, “SYNCING”, “SYNCFAILED”, “WARNING”, “ERROR”, “UNAVAILABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The overall_state of this ManagementStation.
Return type:	str

peer_management_stations¶

[Required] Gets the peer_management_stations of this ManagementStation. A list of other management stations that are behind the same load balancer within a high availability configuration. Stations are identified as peers if they have the same hostname and compartment.

Returns:	The peer_management_stations of this ManagementStation.
Return type:	list[oci.os_management_hub.models.PeerManagementStation]

profile_id¶

Gets the profile_id of this ManagementStation. The OCID of the registration profile used for the management station.

Returns:	The profile_id of this ManagementStation.
Return type:	str

proxy¶

[Required] Gets the proxy of this ManagementStation.

Returns:	The proxy of this ManagementStation.
Return type:	oci.os_management_hub.models.ProxyConfiguration

scheduled_job_id¶

Gets the scheduled_job_id of this ManagementStation. The OCID of the scheduled job for the mirror sync.

Returns:	The scheduled_job_id of this ManagementStation.
Return type:	str

system_tags¶

Gets the system_tags of this ManagementStation. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this ManagementStation.
Return type:	dict(str, dict(str, object))

total_mirrors¶

Gets the total_mirrors of this ManagementStation. The number of software sources that the station is mirroring.

Returns:	The total_mirrors of this ManagementStation.
Return type:	int