oci_swift_password - Create, update and delete Swift (OpenStack Object Store Service) passwords in OCI

New in version 2.5.

Synopsis

  • This module allows the user to create, update and delete Swift passwords in OCI. This module is deprecated. Please use oci_auth_token instead. This module may be removed in a future release. Swift is the OpenStack object storage service. A SwiftPassword is an Oracle-provided password for using a Swift client with the Oracle Cloud Infrastructure Object Storage Service. This password is associated with the user’s Console login. Swift passwords never expire. A user can have up to two Swift passwords at a time. Note - The password is always an Oracle-generated string; you can’t change it to a string of your choice.

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.
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
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.
description
The description you assign to the Swift password during creation. Does not have to be unique, and it's changeable. Required when creating a swift password. The length of the description must be between 1 and 400 characters.
force_create
bool
    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.
key_by
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
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
The state of the swift password that must be asserted to. When state=present, and the swift password doesn't exist, the swift password is created. When state=absent, the swift password is deleted.
swift_password_id
The OCID of the swift password. Required when the password's description needs to be updated with state=present and for deleting a swift password with state=absent

aliases: id
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
user_id
required
The OCID of the user.

Examples

- name: Create a new swift password
  oci_swift_password:
    user_id: "ocid1.user.oc1..xxxxxEXAMPLExxxxx"
    description: "my first swift password"

- name: Update a swift password's description
  oci_swift_password:
        id: "ocid1.credential.oc1..xxxxxEXAMPLExxxxx"
        user_id: "ocid1.user.oc1..xxxxxEXAMPLExxxxx"
        description: "swift password #1"

- name: Delete a swift password
  oci_swift_password:
        id: "ocid1.credential.oc1..xxxxxEXAMPLExxxxx"
        user_id: "ocid1.user.oc1..xxxxxEXAMPLExxxxx"
        state: "absent"

Return Values

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

Key Returned Description
oci_swift_password
dict
On success. The password is only returned only during creation.
Details of the Swift password

Sample:
{'lifecycle_state': 'ACTIVE', 'inactive_status': None, 'user_id': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx', 'description': 'My first swift password description', 'time_created': '2018-01-03T12:47:25.759000+00:00', 'password': '+)UWHJK8UMgMvo5Qv!md', 'id': 'ocid1.credential.oc1..xxxxxEXAMPLExxxxx', 'expires_on': None}


Status

This module is flagged as deprecated which means that .

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

Author

  • Sivakumar Thyagarajan (@sivakumart)

Hint

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