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

Новая в версии 2.8.

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

Обзор

Этот модуль позволяет пользователю создавать, удалять и обновлять виртуальные облачные сети (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 пользователя, от имени которого вызываются OCI-API. Если не задано, используется значение переменной среды 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 сети 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 булево	Варианты: нет ← да	Определяет попытку создания ресурса без идемпотентности. По умолчанию создание ресурса - идемпотентная операция и не создаёт ресурс, если он уже существует. Установка этого параметра в значение «истина» принудительно создаёт копию ресурса, даже если он уже существует. Этот параметр несовместим с key_by.
freeform_tags словарь		Свободные теги для данного ресурса. Каждый тег - простая пара «ключ-значение» без предварительно определенного имени, типа или именованного пространства. Дополнительную информацию см. по адресу https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
key_by список		Список атрибутов этого ресурса, разделенных запятыми, которые должны использоваться для уникальной идентификации экземпляра ресурса. По умолчанию для уникальной идентификации ресурса используются все атрибуты ресурса, за исключением freeform_tags.
region строка		Регион Oracle Cloud Infrastructure, который нужно использовать для всех запросов OCI API. Если не задано, используется значение переменной среды OCI_REGION, если оно есть. Этот параметр требуется, если регион не указан в файле конфигурации (см. `config_file_location`). Для получения дополнительной информации о регионах OCI, см. https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm.
state строка	Варианты: present ← absent	Создать или обновить 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=да.
wait_until строка		Состояние жизненного цикла, в которое должен перейти ресурс, когда wait=да. По умолчанию, когда wait=да, мы ждём, чтобы ресурс перешел в состояние 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
  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
  oci_vcn:
    vcn_id: ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx
    display_name: ansible_vcn

- name: Delete the specified VCN
  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'}

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Rohit Chaware (@rohitChaware)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/oci_vcn_module.html