Модуль cisco.mso.mso_schema_site_vrf_region – Управление регионами VRF локального сайта в шаблоне схемы

Примечание

Этот модуль входит в состав коллекции cisco.mso (версия 2.9.0).

У вас, возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.mso. Для использования этого модуля требуются дополнительные требования, см. Требования для подробностей.

Чтобы использовать его в плейбуке, укажите: cisco.mso.mso_schema_site_vrf_region.

Обзор
Требования
Параметры
Примечания
См. также
Примеры

Обзор

Управление регионами VRF локального сайта в шаблоне схемы на Cisco ACI Multi-Site.

Требования

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

Multi Site Orchestrator версии 2.1 или новее

Параметры

Параметр	Комментарии
container_overlay boolean	Название типа профиля контекста. Поддерживается в версиях MSO 3.3 и выше. Варианты: `false` `true`
host псевдонимы: hostname строка	IP-адрес или имя хоста хоста ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_HOST`.
login_domain строка	Имя домена входа для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI в случае отсутствия этого атрибута будет использоваться переменная инвентаризации `ansible_httpapi_login_domain`.
output_level строка	Влияет на вывод этого модуля MSO. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password строка	Пароль для аутентификации. Если значение не указано в задаче, вместо него будут использованы переменные среды `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_PORT`.
region псевдонимы: name строка	Имя управляемой области.
schema строка / обязательно	Имя схемы.
site строка / обязательно	Имя сайта.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
template строка / обязательно	Имя шаблона.
timeout целое число	Тайм-аут уровня сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_TIMEOUT`.
underlay_context_profile словарь	Имя типа профиля контекста. Этот параметр можно добавить только при container_overlay = True. Поддерживается в версиях MSO 3.3 и выше.
region строка / обязательно	Имя области, связанной с VRF подложки профиля контекста.
vrf строка / обязательно	Имя VRF, которое следует ассоциировать с профилем контекста подложки.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_PROXY`. Значение по умолчанию — `true`. Варианты: `false` `true`
use_ssl boolean	Если `false`, вместо стандартного HTTPS-соединения будет использоваться HTTP-соединение. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_SSL`. При использовании плагина подключения HTTPAPI в случае отсутствия этого атрибута будет использоваться переменная инвентаризации `ansible_httpapi_use_ssl`. Значение по умолчанию — `false` при использовании плагина HTTPAPI (mso или nd) и `true` при использовании устаревшего метода подключения (только для mso). Варианты: `false` `true`

логин строка	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных среды `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs логическое	Если `false`, сертификаты SSL не будут проверены. Это следует установить в `false` только при работе с сайтами, управляемыми самостоятельно, использующими самозаверяющие сертификаты. Если значение не указано в задаче, будет использовано значение переменной среды `MSO_VALIDATE_CERTS`. По умолчанию `true`. Варианты: `false` `true`
vpn_gateway_router логическое	Включен ли VPN Gateway Router. Варианты: `false` `true`
vrf строка / обязательно	Имя VRF.

Примечания

Примечание

Из-за ограничений API MSO REST этот модуль не может создавать пустые регионы (то есть регионы без cidr). Используйте модуль cisco.mso.mso_schema_site_vrf_region_cidr для автоматического создания регионов с cidr.
Этот модуль был разработан для поддержки Multi Site Orchestrator v2.1 или более поздних версий. Некоторые или все функции могут не работать в более ранних версиях.

См. также

cisco.mso.mso_schema_site_vrf: Управление локальными VRF на уровне сайта в схеме шаблона.
cisco.mso.mso_schema_template_vrf: Управление VRF в схемах шаблонов.

Примеры

- name: Remove VPN Gateway Router at site VRF Region
  cisco.mso.mso_schema_site_vrf_region:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    vrf: VRF1
    region: us-west-1
    vpn_gateway_router: false
    state: present

- name: Remove a site VRF region
  cisco.mso.mso_schema_site_vrf_region:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    vrf: VRF1
    region: us-west-1
    state: absent

- name: Query a specific site VRF region
  cisco.mso.mso_schema_site_vrf_region:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    vrf: VRF1
    region: us-west-1
    state: query
  register: query_result

- name: Query all site VRF regions
  cisco.mso.mso_schema_site_vrf_region:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    vrf: VRF1
    state: query
  register: query_result

Авторы

Anvitha Jain (@anvitha-jain)
Dag Wieers (@dagwieers)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/mso/mso_schema_site_vrf_region_module.html