Spec-Zone.ru › Ansible 2.9

icx_config – Управление разделами конфигурации коммутаторов Ruckus ICX 7000 серии

Новое в версии 2.9.

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

Описание

  • Конфигурации Ruckus ICX используют простой синтаксис отступа для разбиения конфигурации на разделы. Этот модуль предоставляет реализацию для работы с разделами конфигурации ICX детерминированным способом.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
after
список
Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Подобно параметру before, это позволяет разработчику playbook добавить набор команд, которые будут выполнены после набора команд.
backup
логическое
    Варианты:
  • нет ←
  • да
Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удаленного устройства перед внесением любых изменений. Файл резервной копии записывается в папку backup в корневом каталоге playbook или в корневом каталоге роли, если playbook является частью роли Ansible. Если каталог не существует, он создается.
before
список
Упорядоченный набор команд для добавления в стек команд, если требуется внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации перед внесением каких-либо изменений, не влияя на способ сопоставления набора команд с системой.
defaults
логическое
    Варианты:
  • нет ←
  • да
Этот аргумент указывает, нужно ли собирать все значения по умолчанию при получении рабочей конфигурации удаленного устройства. При включении модуль получит текущую конфигурацию, выполнив команду show running-config all.
diff_against
строка
    Варианты:
  • рабочая
  • стартовая
  • изначальная
При использовании аргумента командной строки ansible-playbook --diff модуль может генерировать различия с разными источниками.
Когда этот параметр настроен как стартовая, модуль вернёт разницу между рабочей конфигурацией и конфигурацией.
Когда этот параметр настроен как изначальная, модуль вернет разницу между рабочей конфигурацией и конфигурацией, предоставленной в аргументе intended_config.
Когда этот параметр настроен как рабочая, модуль вернёт разницу между рабочей конфигурацией до и после изменений, внесенных в конфигурацию устройства.
diff_ignore_lines
список
Используйте этот аргумент для указания одной или нескольких строк, которые должны быть пропущены при сравнении. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк.
intended_config
строка
intended_config предоставляет основную конфигурацию, которой должен соответствовать узел, и используется для проверки конечной рабочей конфигурации. Этот аргумент не будет изменять какие-либо параметры на удалённом устройстве и используется исключительно для проверки соответствия текущей конфигурации устройства. При указании этого аргумента задача также должна изменить значение diff_against и установить его в изначальная.
lines
список
Упорядоченный набор команд, которые должны быть сконфигурированы в разделе. Команды должны быть идентичны командам, найденным в рабочей конфигурации устройства. Убедитесь, что вы учитываете синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства.

алиасы: команды
match
строка
    Варианты:
  • строка ←
  • строгое
  • точное
  • нет
Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлено в строка, команды сопоставляются по строкам. Если match установлено в строгое, строки команд сопоставляются по положению. Если match установлено в точное, строки команд должны быть точным совпадением. Наконец, если match установлено в нет, модуль не будет пытаться сравнивать исходную конфигурацию с рабочей конфигурацией на удалённом устройстве.
multiline_delimiter
строка
Значение по умолчанию:
"@"
Этот аргумент используется при отправке многострочного элемента конфигурации на устройство ICX. Он указывает символ, используемый в качестве разделителя. Это относится только к действию конфигурации.
parents
список
Упорядоченный набор родителей, которые однозначно идентифицируют раздел или иерархию, по которым должны проверяться команды. Если аргумент parents опущен, команды проверяются по отношению к набору команд верхнего уровня или глобальных команд.
replace
строка
    Варианты:
  • строка ←
  • блок
Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в строка, изменённые строки отправляются на устройство в режиме конфигурации. Если аргумент replace установлен в блок, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка неверна.
running_config
строка
Модуль по умолчанию подключается к удалённому устройству и извлекает текущую рабочую конфигурацию для использования в качестве основы для сравнения с содержимым источника. Иногда нежелательно, чтобы задача получала текущую рабочую конфигурацию для каждой задачи в playbook. Аргумент running_config позволяет разработчику передать конфигурацию, используемую в качестве основной конфигурации для сравнения.

алиасы: конфигурация
save_when
строка
    Варианты:
  • всегда
  • никогда ←
  • изменено
  • изменилось
Когда вносятся изменения в рабочую конфигурацию устройства, изменения по умолчанию не копируются в постоянное хранилище. С помощью этого аргумента можно изменить это. Если аргумент установлен в всегда, то рабочая конфигурация всегда копируется в стартовую конфигурацию, а флаг изменено всегда устанавливается в True. Если аргумент установлен в изменено, то рабочая конфигурация копируется в стартовую конфигурацию только в том случае, если она изменилась с момента последней сохранения конфигурации. Если аргумент установлен в никогда, рабочая конфигурация никогда не копируется в конфигурацию. Если аргумент установлен в изменилось, то рабочая конфигурация копируется в конфигурацию только в том случае, если задача внесла изменения.
src
строка
Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корня playbook или роли. Этот аргумент несовместим с аргументами lines и parents.

Примечания

Примечание

  • Проверено на ICX 10.1.
  • Для получения информации об использовании платформы ICX см. Руководство по платформе ICX OS.

Примеры

- name: configure top level configuration
  icx_config:
    lines: hostname {{ inventory_hostname }}

- name: configure interface settings
  icx_config:
    lines:
      - port-name test string
      - ip address 172.31.1.1 255.255.255.0
    parents: interface ethernet 1/1/2

- name: configure ip helpers on multiple interfaces
  icx_config:
    lines:
      - ip helper-address 172.26.1.10
      - ip helper-address 172.26.3.8
    parents: "{{ item }}"
  with_items:
    - interface ethernet 1/1/2
    - interface ethernet 1/1/3

- name: load new acl into device
  icx_config:
    lines:
      - permit ip host 192.0.2.1 any log
      - permit ip host 192.0.2.2 any log
      - permit ip host 192.0.2.3 any log
      - permit ip host 192.0.2.4 any log
    parents: ip access-list extended test
    before: no ip access-list extended test
    match: exact

- name: check the running-config against master config
  icx_config:
    diff_against: intended
    intended_config: "{{ lookup('file', 'master.cfg') }}"

- name: check the configuration against the running-config
  icx_config:
    diff_against: startup
    diff_ignore_lines:
      - ntp clock .*

- name: for idempotency, use full-form commands
  icx_config:
    lines:
      # - en
      - enable
    # parents: int eth1/0/11
    parents: interface ethernet 1/1/2

# Set boot image based on comparison to a group_var (version) and the version
# that is returned from the `icx_facts` module
- name: SETTING BOOT IMAGE
  icx_config:
    lines:
      - no boot system
      - boot system flash bootflash:{{new_image}}
    host: "{{ inventory_hostname }}"
  when: ansible_net_version != version

- name: render template onto an ICX device
  icx_config:
    backup: yes
    src: "{{ lookup('file', 'config.j2') }}"

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

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

Ключ Возвращаемое значение Описание
backup_path
строка
при backup = да
Полный путь к резервной копии файла

Пример:
/playbooks/ansible/backup/icx_config.2016-07-16@22:28:34
commands
список
всегда
Набор команд, которые будут отправлены на удаленное устройство

Пример:
['hostname foo', 'router ospf 1', 'router-id 192.0.2.1']
updates
список
всегда
Набор команд, которые будут отправлены на удаленное устройство

Пример:
['hostname foo', 'router ospf 1', 'router-id 192.0.2.1']


Статус

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

Авторы

  • Ruckus Wireless (@Commscope)

Подсказка

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

© 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/icx_config_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API