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

api_user

string

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

string

Отпечаток для используемой пары ключей. Если не задано, используется значение переменной среды OCI_USER_FINGERPRINT, если таковая существует. Этот параметр обязателен, если отпечаток ключа не указан в конфигурационном файле (см. config_file_location). Чтобы получить значение отпечатка пары ключей, обратитесь к https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.

api_user_key_file

path

Полный путь и имя файла закрытого ключа (в формате PEM). Если не задано, используется значение переменной OCI_USER_KEY_FILE, если таковая существует. Этот параметр обязателен, если закрытый ключ не указан в конфигурационном файле (см. config_file_location). Если ключ зашифрован с помощью парольной фразы, необходимо также указать параметр api_user_key_pass_phrase.

api_user_key_pass_phrase

string

Парольная фраза, используемая ключом, на который ссылается api_user_key_file, если он зашифрован. Если не задано, используется значение переменной OCI_USER_KEY_PASS_PHRASE, если таковая существует. Этот параметр обязателен, если парольная фраза ключа не указана в конфигурационном файле (см. config_file_location).

auth_type

string

Тип аутентификации, используемый для выполнения запросов API. По умолчанию выполняется аутентификация на основе auth_type=api_key и используется ключ API (см. api_user_key_file) в вашем конфигурационном файле. Если этот параметр модуля «auth_type» не указан, используется значение переменной OCI_ANSIBLE_AUTH_TYPE, если таковая существует. Используйте auth_type=instance_principal для использования аутентификации на основе принципала экземпляра при выполнении playbook Ansible на экземпляре вычислений OCI.

Варианты:

• "api_key" ← (по умолчанию)
• "instance_principal"

cidr_block

string

CIDR-блок IP-адресов VCN. Обязательно при создании VCN с state=present.

compartment_id

string

OCID отсека, в котором должен находиться VCN. Обязательно при создании VCN с state=present. Этот параметр взаимоисключающий с vcn_id.

config_file_location

string

Путь к конфигурационному файлу. Если не задано, используется значение переменной среды OCI_CONFIG_FILE, если таковая существует. В противном случае используется значение по умолчанию ~/.oci/config.

config_profile_name

string

Профиль для загрузки из конфигурационного файла, на который ссылается config_file_location. Если не задано, используется значение переменной среды OCI_CONFIG_PROFILE, если таковая существует. В противном случае используется профиль DEFAULT в config_file_location.

Значение по умолчанию: "DEFAULT"

defined_tags

dictionary

Заданные теги для этого ресурса. Каждый ключ предопределен и имеет область действия в пространстве имен. Для получения дополнительной информации см. https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.

display_name

псевдонимы: name

string

Удобное для пользователя имя. Не обязательно должно быть уникальным и может быть изменено.

dns_label

string

Метка DNS для VCN, используемая вместе с именем хоста VNIC и меткой DNS подсети для формирования полного доменного имени (FQDN) для каждого VNIC в этой подсети (например, bminstance-1.subnet123.vcn1.oraclevcn.com). Не обязательно должно быть уникальным, но рекомендуется устанавливать уникальные метки DNS для VCN в вашем арендаторе. Должно быть альфанумерическим строкой, начинающейся с буквы. Значение не может быть изменено.

force_create

boolean

Следует ли пытаться создать ресурс неидемпотентным способом. По умолчанию создание ресурса является идемпотентной операцией и не создает ресурс, если он уже существует. Установка этого параметра в true принудительно создает копию ресурса, даже если он уже существует. Этот параметр взаимоисключающий с key_by.

Варианты:

• false ← (по умолчанию)
• true

freeform_tags

dictionary

Теги свободного формата для этого ресурса. Каждый тег представляет собой простую пару «ключ-значение» без предопределенного имени, типа или пространства имен. Для получения дополнительной информации см. https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.

key_by

list / elements=string

Список атрибутов этого ресурса, разделенных запятыми, которые должны использоваться для однозначной идентификации экземпляра ресурса. По умолчанию для однозначной идентификации ресурса используются все атрибуты ресурса, кроме freeform_tags.

region

string

Регион Oracle Cloud Infrastructure, который будет использоваться для всех запросов API OCI. Если не задан, используется значение переменной OCI_REGION, если она существует. Этот параметр необходим, если регион не указан в файле конфигурации (см. config_file_location). Дополнительную информацию о регионах OCI см. на странице https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm.

state

string

Создать или обновить VCN с state=present. Используйте state=absent для удаления VCN.

Варианты:

• "present" ← (по умолчанию)
• "absent"

tenancy

string

OCID вашей аренды. Если не задан, используется значение переменной OCI_TENANCY, если она существует. Этот параметр необходим, если OCID аренды не указан в файле конфигурации (см. config_file_location). Чтобы получить OCID аренды, обратитесь к https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.

vcn_id

aliases: id

string

OCID VCN. Требуется при удалении VCN с state=absent или обновлении VCN с state=present. Этот параметр взаимоисключающий с compartment_id.

wait

boolean

Ожидать завершения операции создания или удаления.

Варианты:

• false
• true ← (по умолчанию)

wait_timeout

integer

Время ожидания при wait=true.

По умолчанию: 1200

wait_until

string

Состояние жизненного цикла, в которое необходимо перевести ресурс при wait=true. По умолчанию, при wait=true, мы ждем перехода ресурса в состояние ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING во время операции создания и в состояние DELETED/DETACHED/TERMINATED во время операции удаления.