community.general.oci_vcn – Управление виртуальными облачными сетями (VCN) в OCI

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general

Для использования в книге задач укажите: community.general.oci_vcn

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет пользователю создавать, удалять и обновлять виртуальные облачные сети (VCN) в OCI. Полные модули Oracle Cloud Infrastructure Ansible можно загрузить с https://github.com/oracle/oci-ansible-modules/releases.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

python >= 2.7
Python SDK для Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_user строка		OCID пользователя, от имени которого вызываются API OCI. Если не задано, используется значение переменной окружения OCI_USER_OCID, если таковая имеется. Этот параметр требуется, если пользователь не указан в файле конфигурации (см. `config_file_location`). Для получения OCID пользователя, пожалуйста, обратитесь к https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint строка		Отпечаток ключа для используемой пары ключей. Если не задано, используется значение переменной окружения OCI_USER_FINGERPRINT, если таковая имеется. Этот параметр требуется, если отпечаток ключа не указан в файле конфигурации (см. `config_file_location`). Для получения значения отпечатка пары ключей, пожалуйста, обратитесь к https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file строка		Полный путь и имя файла закрытого ключа (в формате PEM). Если не задано, используется значение переменной OCI_USER_KEY_FILE, если таковая имеется. Этот параметр требуется, если закрытый ключ не указан в файле конфигурации (см. `config_file_location`). Если ключ зашифрован с парольной фразой, также необходимо указать параметр `api_user_key_pass_phrase`
api_user_key_pass_phrase строка		Парольная фраза, используемая для ключа, указанного в `api_user_key_file`, если он зашифрован. Если не задано, используется значение переменной окружения OCI_USER_KEY_PASS_PHRASE, если таковая имеется. Этот параметр требуется, если парольная фраза ключа не указана в файле конфигурации (см. `config_file_location`).
auth_type строка	Варианты: api_key ← instance_principal	Тип аутентификации для запросов API. По умолчанию выполняется аутентификация на основе `auth_type="api_key"`, и используется API-ключ (см. api_user_key_file) в вашем файле конфигурации. Если этот параметр auth_type модуля не задан, используется значение OCI_ANSIBLE_AUTH_TYPE, если таковое имеется. Используйте `auth_type="instance_principal"` для использования аутентификации на основе принципала экземпляра при выполнении книг задач Ansible внутри экземпляра вычислений OCI.
cidr_block строка		Блок CIDR IP-адресов VCN. Требуется при создании VCN со значением state=present.
compartment_id строка		OCID компартмента, содержащего VCN. Требуется при создании VCN со значением state=present. Этот параметр несовместим с vcn_id.
config_file_location строка		Путь к файлу конфигурации. Если не задан, используется значение переменной окружения OCI_CONFIG_FILE, если таковое имеется. В противном случае используется значение по умолчанию ~/.oci/config.
config_profile_name строка	По умолчанию: "DEFAULT"	Профиль для загрузки из файла конфигурации, указанного в `config_file_location`. Если не задано, используется значение переменной окружения OCI_CONFIG_PROFILE, если таковое имеется. В противном случае используется профиль "DEFAULT" в `config_file_location`.
defined_tags словарь		Определенные теги для данного ресурса. Каждый ключ предварительно определён и ограничен по пространству имён. Дополнительная информация доступна по адресу https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
display_name строка		Наглядное имя. Необязательно уникальное, может быть изменено. псевдонимы: name
dns_label строка		Метка DNS для VCN, используемая совместно с именем хоста VNIC и меткой DNS подсети для формирования полного доменного имени (FQDN) для каждого VNIC в этой подсети (например, bminstance-1.subnet123.vcn1.oraclevcn.com). Необязательно уникальное, но рекомендуется устанавливать уникальные метки DNS для VCN в вашей аренде. Должно быть строкой, содержащей только буквенно-цифровые символы, начинающейся с буквы. Значение изменить нельзя.
force_create булево	Варианты: нет ← да	Необходимо ли попытаться выполнить неидемпотентное создание ресурса. По умолчанию создание ресурса идемпотентно и не создаёт ресурс, если он уже существует. Установка этого параметра в значение true принудительно создаёт копию ресурса, даже если он уже существует. Этот параметр несовместим с key_by.
freeform_tags словарь		Свободные теги для данного ресурса. Каждый тег представляет собой простую пару ключ-значение без предварительно определённого имени, типа или пространства имён. Дополнительная информация доступна по адресу https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
key_by список / элементы=строка		Список, содержащий через запятую атрибуты этого ресурса, которые должны быть использованы для уникальной идентификации экземпляра ресурса. По умолчанию для уникальной идентификации ресурса используются все атрибуты, кроме freeform_tags.
region строка		Регион Oracle Cloud Infrastructure, который необходимо использовать для всех запросов API OCI. Если не задано, используется значение переменной окружения OCI_REGION, если таковая имеется. Этот параметр требуется, если регион не указан в файле конфигурации (см. `config_file_location`). Дополнительная информация о регионах OCI доступна по адресу https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm.
state строка	Варианты: наличие ← отсутствие	Создать или обновить VCN со значением state=present. Используйте state=absent для удаления VCN.
tenancy строка		OCID вашей аренды. Если не задано, используется значение переменной окружения OCI_TENANCY, если таковое имеется. Этот параметр требуется, если OCID аренды не указан в файле конфигурации (см. `config_file_location`). Для получения OCID аренды, пожалуйста, обратитесь к https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
vcn_id строка		OCID VCN. Требуется при удалении VCN со значением state=absent или обновлении VCN со значением state=present. Этот параметр несовместим с compartment_id. псевдонимы: id
wait булево	Варианты: нет да ←	Ожидать завершения операции создания или удаления.
wait_timeout целое число	По умолчанию: 1200	Время ожидания в секундах, когда wait=yes.
wait_until строка		Состояние жизненного цикла, ожидание перехода ресурса в это состояние, когда wait=yes. По умолчанию, при wait=yes, мы ждём, пока ресурс перейдёт в состояние ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING во время операции создания и в состояние DELETED/DETACHED/ TERMINATED во время операции удаления.

Примечания

Примечание

Для конфигурации OCI python sdk, обратитесь к https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Примеры

- name: Create a VCN
  community.general.oci_vcn:
    cidr_block: '10.0.0.0/16'
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
    display_name: my_vcn
    dns_label: ansiblevcn

- name: Updates the specified VCN's display name
  community.general.oci_vcn:
    vcn_id: ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx
    display_name: ansible_vcn

- name: Delete the specified VCN
  community.general.oci_vcn:
    vcn_id: ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx
    state: absent

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
vcn словарь	При успешной операции создания и обновления	Информация о VCN Пример: {'cidr_block': '10.0.0.0/16', 'compartment_id"': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'default_dhcp_options_id': 'ocid1.dhcpoptions.oc1.phx.xxxxxEXAMPLExxxxx', 'default_route_table_id': 'ocid1.routetable.oc1.phx.xxxxxEXAMPLExxxxx', 'default_security_list_id': 'ocid1.securitylist.oc1.phx.xxxxxEXAMPLExxxxx', 'display_name': 'ansible_vcn', 'dns_label': 'ansiblevcn', 'id': 'ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx', 'lifecycle_state': 'AVAILABLE', 'time_created': '2017-11-13T20:22:40.626000+00:00', 'vcn_domain_name': 'ansiblevcn.oraclevcn.com'}

Авторы

Rohit Chaware (@rohitChaware)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/oci_vcn_module.html