Skip to content

Latest commit

 

History

History
344 lines (299 loc) · 25.2 KB

oci_dynamic_group_module.rst

File metadata and controls

344 lines (299 loc) · 25.2 KB
Raw
source:cloud/oracle/oci_dynamic_group.py
orphan:

oci_dynamic_group - Manage dynamic groups in OCI

.. versionadded:: 2.5

Synopsis

  • This module allows the user to create, delete and update dynamic groups in Oracle Cloud Infrastructure.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
api_user
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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
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
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
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_type
    Choices:
  • api_key ←
  • instance_principal
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.
compartment_id
The OCID of the tenancy containing the group. Required to create a dynamic group.
config_file_location
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 Default:
DEFAULT
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
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
description
The description you assign to the group during creation. Does not have to be unique, and it's changeable. Required to create a dynamic group.
dynamic_group_id
The OCID of the dynamic group. Required to delete or update a dynamic group.

aliases: id
freeform_tags
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
matching_rule
The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingdynamicgroups.htm. Required to create a dynamic group.
name
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed. Required to create a dynamic group.
region
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
    Choices:
  • present ←
  • absent
Create or update a dynamic group with state=present. Use state=absent to delete a dynamic group.
tenancy
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
bool
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Notes

Examples

- name: Create a dynamic group
  oci_dynamic_group:
    compartment_id: ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx
    description: Group for all instances that are in a specific compartment
    matching_rule: "instance.compartment.id = 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'"
    name: Sample dynamic group

- name: Update matching rule and description of a dynamic group
  oci_dynamic_group:
    id: ocid1.dynamicgroup.oc1..xxxxxEXAMPLExxxxx
    description: Group for all instances with the tag namespace and tag key operations.department
    matching_rule: "tag.operations.department.value"

- name: Delete a dynamic group
  oci_dynamic_group:
    id: ocid1.dynamicgroup.oc1..xxxxxEXAMPLExxxxx
    state: absent

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

Key Returned Description
dynamic_group
dict
 On successful create, delete & update operation
Information about the dynamic group

Sample:
{'lifecycle_state': 'ACTIVE', 'inactive_status': None, 'description': 'Group for all instances with the tag namespace and tag key operations.department', 'compartment_id': 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx', 'matching_rule': 'tag.operations.department.value', 'time_created': '2018-07-05T09:38:27.176000+00:00', 'id': 'ocid1.dynamicgroup.oc1..xxxxxEXAMPLExxxxx', 'name': 'Sample dynamic group'}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Rohit Chaware (@rohitChaware)

Hint

If you notice any issues in this documentation you can edit this document to improve it.