модуль cisco.mso.mso_schema_site_l3out — управление локальными для сайта Layer 3 Out (L3Out) в шаблоне схемы

Примечание

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

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

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

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

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры

Краткое описание

Управление локальными для сайта L3Out в шаблоне схемы в Cisco ACI Multi-Site.
Этот модуль можно использовать только с версиями MSO 3.0 и выше.
ПРИМЕЧАНИЕ — использование этого модуля с версиями ниже 3.0 может нарушить работу MSO.

Требования

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

Multi Site Orchestrator v2.1 или новее

Параметры

Параметр	Комментарии
host псевдонимы: hostname строка	IP-адрес или имя хоста узла ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_HOST`.
l3out псевдонимы: name строка	Имя управляемого l3out.
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`.
schema строка / обязательный	Имя схемы.
site строка / обязательный	Имя сайта.
state строка	Для добавления или удаления используйте `present` или `absent`. Для получения списка одного или нескольких объектов используйте `query`. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
template строка / обязательный	Имя шаблона.
timeout целое число	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_TIMEOUT`.
use_proxy логическое значение	Если `false`, прокси использоваться не будет, даже если он задан в переменной среды на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_PROXY`. Значение по умолчанию — `true`. Варианты: `false` `true`
use_ssl логическое значение	Если `false`, вместо HTTPS-подключения по умолчанию будет использоваться HTTP-подключение. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_SSL`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использована переменная инвентаря `ansible_httpapi_use_ssl`. При использовании плагина подключения HTTPAPI (mso или nd) значение по умолчанию — `false`, а при использовании устаревшего способа подключения (только для mso) — `true`. Варианты: `false` `true`
username строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs логическое значение	Если `false`, SSL-сертификаты проверяться не будут. Значение `false` следует задавать только для контролируемых пользователем сайтов с самоподписанными сертификатами. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`
vrf словарь	VRF, связанный с этим L3out.
name строка / обязательный	Имя связываемой VRF.
schema строка	Схема, в которой определена указанная VRF. Если этот параметр не задан, по умолчанию используется текущая схема.
template строка	Шаблон, в котором определена указанная VRF. Если этот параметр не задан, по умолчанию используется текущая схема.

Примечания

Примечание

Этот модуль разработан для поддержки Multi Site Orchestrator v2.1 или новее. Некоторые или все функции могут не работать в более ранних версиях.

См. также

cisco.mso.mso_schema_site: Управление сайтами в схемах.
cisco.mso.mso_schema_template_l3out: Управление l3out в шаблонах схем.

Примеры

- name: Add a new site L3Out
  cisco.mso.mso_schema_site_l3out:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    l3out: L3out1
    vrf:
      name: vrfName
      template: TemplateName
      schema: schemaName
    state: present

- name: Remove a site L3Out
  cisco.mso.mso_schema_site_l3out:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    l3out: L3out1
    state: absent

- name: Query a specific site L3Out
  cisco.mso.mso_schema_site_l3out:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    l3out: L3out1
    state: query
  register: query_result

- name: Query all site l3outs
  cisco.mso.mso_schema_site_l3out:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    state: query
  register: query_result

Авторы

Anvitha Jain (@anvitha-jain)

Ссылки на коллекцию

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