oracle.oci.oci_os_management_hub_management_station – Manage a ManagementStation resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_os_management_hub_management_station.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a ManagementStation resource in Oracle Cloud Infrastructure

  • For state=present, create a management station. You must provide proxy and mirror configuration information.

  • This resource has the following action operations in the oracle.oci.oci_os_management_hub_management_station_actions module: change_compartment, refresh_management_station_config, synchronize_mirrors.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The OCID of the compartment that contains the management station.
Required for create using state=present.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
description
string
User-specified description of the management station. Avoid entering confidential information.
This parameter is updatable.
display_name
string
User-friendly name for the management station. Does not have to be unique and you can change the name later. Avoid entering confidential information.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
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"}`
This parameter is updatable.
hostname
string
Hostname of the management station.
Required for create using state=present.
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
management_station_id
string
The OCID of the management station.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
mirror
dictionary
Required for create using state=present.
This parameter is updatable.
directory
string / required
Path to the data volume on the management station where software source mirrors are stored.
This parameter is updatable.
port
string / required
Default mirror listening port for http.
This parameter is updatable.
sslcert
string
Path to the SSL cerfificate.
This parameter is updatable.
sslport
string / required
Default mirror listening port for https.
This parameter is updatable.
proxy
dictionary
Required for create using state=present.
This parameter is updatable.
forward
string
The URL the proxy will forward to.
This parameter is updatable.
hosts
list / elements=string
List of hosts.
This parameter is updatable.
is_enabled
boolean / required
    Choices:
  • no
  • yes
Indicates if the proxy should be enabled or disabled. Default is enabled.
This parameter is updatable.
port
string
Listening port used for the proxy.
This parameter is updatable.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state
string
    Choices:
  • present ←
  • absent
The state of the ManagementStation.
Use state=present to create or update a ManagementStation.
Use state=absent to delete a ManagementStation.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create management_station
  oci_os_management_hub_management_station:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    hostname: hostname_example
    proxy:
      # required
      is_enabled: true

      # optional
      hosts: [ "hosts_example" ]
      port: port_example
      forward: forward_example
    mirror:
      # required
      directory: directory_example
      port: port_example
      sslport: sslport_example

      # optional
      sslcert: sslcert_example

    # optional
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update management_station
  oci_os_management_hub_management_station:
    # required
    management_station_id: "ocid1.managementstation.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    hostname: hostname_example
    proxy:
      # required
      is_enabled: true

      # optional
      hosts: [ "hosts_example" ]
      port: port_example
      forward: forward_example
    mirror:
      # required
      directory: directory_example
      port: port_example
      sslport: sslport_example

      # optional
      sslcert: sslcert_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update management_station using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_os_management_hub_management_station:
    # required
    display_name: display_name_example

    # optional
    description: description_example
    hostname: hostname_example
    proxy:
      # required
      is_enabled: true

      # optional
      hosts: [ "hosts_example" ]
      port: port_example
      forward: forward_example
    mirror:
      # required
      directory: directory_example
      port: port_example
      sslport: sslport_example

      # optional
      sslcert: sslcert_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete management_station
  oci_os_management_hub_management_station:
    # required
    management_station_id: "ocid1.managementstation.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete management_station using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_os_management_hub_management_station:
    # required
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
management_station
complex
on success
Details of the ManagementStation resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'health': {'description': 'description_example', 'state': 'HEALTHY'}, 'hostname': 'hostname_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'managed_instance_id': 'ocid1.managedinstance.oc1..xxxxxxEXAMPLExxxxxx', 'mirror': {'directory': 'directory_example', 'port': 'port_example', 'sslcert': 'sslcert_example', 'sslport': 'sslport_example'}, 'mirror_capacity': 56, 'mirror_sync_status': {'failed': 56, 'queued': 56, 'synced': 56, 'syncing': 56, 'unsynced': 56}, 'overall_percentage': 56, 'overall_state': 'NORMAL', 'profile_id': 'ocid1.profile.oc1..xxxxxxEXAMPLExxxxxx', 'proxy': {'forward': 'forward_example', 'hosts': [], 'is_enabled': True, 'port': 'port_example'}, 'scheduled_job_id': 'ocid1.scheduledjob.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'total_mirrors': 56}
 
compartment_id
string
on success
The OCID of the compartment that contains the management station.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
User-specified description for the management station.

Sample:
description_example
 
display_name
string
on success
A user-friendly name for the management station.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
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"}`

Sample:
{'Department': 'Finance'}
 
health
complex
on success

   
description
string
on success
Explanation of the health status.

Sample:
description_example
   
state
string
on success
Overall health status of the management station.

Sample:
HEALTHY
 
hostname
string
on success
Hostname of the management station.

Sample:
hostname_example
 
id
string
on success
The OCID of the management station.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the management station.

Sample:
CREATING
 
managed_instance_id
string
on success
The OCID of the instance that is acting as the management station.

Sample:
ocid1.managedinstance.oc1..xxxxxxEXAMPLExxxxxx
 
mirror
complex
on success

   
directory
string
on success
Path to the data volume on the management station where software source mirrors are stored.

Sample:
directory_example
   
port
string
on success
Default mirror listening port for http.

Sample:
port_example
   
sslcert
string
on success
Path to the SSL cerfificate.

Sample:
sslcert_example
   
sslport
string
on success
Default mirror listening port for https.

Sample:
sslport_example
 
mirror_capacity
integer
on success
A decimal number representing the amount of mirror capacity used by the sync.

Sample:
56
 
mirror_sync_status
complex
on success

   
failed
integer
on success
Total number of software sources that failed to sync.

Sample:
56
   
queued
integer
on success
Total number of software sources that are queued for sync.

Sample:
56
   
synced
integer
on success
Total number of software sources that successfully synced.

Sample:
56
   
syncing
integer
on success
Total number of software sources currently syncing.

Sample:
56
   
unsynced
integer
on success
Total number of software sources that have not yet been synced.

Sample:
56
 
overall_percentage
integer
on success
A decimal number representing the progress of the current mirror sync.

Sample:
56
 
overall_state
string
on success
Current state of the mirror sync for the management station.

Sample:
NORMAL
 
profile_id
string
on success
The OCID of the registration profile used for the management station.

Sample:
ocid1.profile.oc1..xxxxxxEXAMPLExxxxxx
 
proxy
complex
on success

   
forward
string
on success
The URL the proxy will forward to.

Sample:
forward_example
   
hosts
list / elements=string
on success
List of hosts.
   
is_enabled
boolean
on success
Indicates if the proxy should be enabled or disabled. Default is enabled.

Sample:
True
   
port
string
on success
Listening port used for the proxy.

Sample:
port_example
 
scheduled_job_id
string
on success
The OCID of the scheduled job for the mirror sync.

Sample:
ocid1.scheduledjob.oc1..xxxxxxEXAMPLExxxxxx
 
system_tags
dictionary
on success
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
total_mirrors
integer
on success
The number of software sources that the station is mirroring.

Sample:
56


Authors

  • Oracle (@oracle)