Spec-Zone.ru › Ansible

community.network.ig_config модуль — Управление базой данных конфигурации на Ingate SBC.

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

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

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

Для использования в книге задач укажите: community.network.ig_config.

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

Обзор

  • Управление базой данных конфигурации на Ingate SBC.

Псевдонимы: network.ingate.ig_config

Требования

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

  • ingatesdk >= 1.0.6

Параметры

Параметр

Комментарии

add

boolean

Добавить строку в таблицу.

Варианты:

  • false
  • true

client

string

Объект dict, содержащий детали подключения.

address

string / обязательно

Имя хоста или IP-адрес устройства.

password

string / обязательно

Пароль пользователя REST API.

port

integer

Порт HTTP(S) для подключения.

scheme

string / обязательно

Используемый протокол HTTP.

Варианты:

  • "http"
  • "https"

timeout

integer

Таймаут (в секундах) для запросов REST API.

username

string / обязательно

Имя пользователя REST API.

validate_certs

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

boolean

Проверка сертификата HTTPS устройства.

Варианты:

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

version

string

Версия REST API.

Варианты:

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

columns

string

Словарь, содержащий имена/значения столбцов.

delete

boolean

Удалить все строки в таблице или определенную строку.

Варианты:

  • false
  • true

download

boolean

Загрузить базу данных конфигурации с устройства.

Варианты:

  • false
  • true

factory

boolean

Сбросить предварительную конфигурацию до заводских значений.

Варианты:

  • false
  • true

filename

string

Имя файла для сохранения загруженной конфигурации. См. опцию download.

get

boolean

Возвратить все строки в таблице или определенную строку.

Варианты:

  • false
  • true

modify

boolean

Изменить строку в таблице.

Варианты:

  • false
  • true

no_response

boolean

Ожидать отсутствия ответа при сохранении предварительной конфигурации. См. опцию store.

Варианты:

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

path

string

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

return_rowid

boolean

Получить ID строки(ок) из таблицы, где столбцы совпадают.

Варианты:

  • false
  • true

revert

boolean

Сбросить предварительную конфигурацию.

Варианты:

  • false
  • true

rowid

integer

ID строки.
END_OF_DOCUMENT_MARKER

store

boolean

Сохранить предварительную конфигурацию.

Варианты:

  • false
  • true

store_download

boolean

Если загруженная конфигурация должна быть сохранена на диске. Обратитесь к параметру download.

Варианты:

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

table

string

Имя таблицы.

Примечания

Примечание

  • Если store_download установлено в значение True, и path и filename опущены, файл будет сохранён в текущем каталоге с автоматически сгенерированным именем.
  • Для работы этого модуля необходимо установить Ingate Python SDK на хосте. Для установки SDK используйте команду pip из вашей оболочки pip install ingatesdk.

Примеры

- name: Add/remove DNS servers
  hosts: 192.168.1.1
  connection: local
  vars:
    client_rw:
      version: v1
      address: "{{ inventory_hostname }}"
      scheme: http
      username: alice
      password: foobar
  tasks:

  - name: Load factory defaults
    community.network.ig_config:
      client: "{{ client_rw }}"
      factory: true
    register: result
  - ansible.builtin.debug:
      var: result

  - name: Revert to last known applied configuration
    community.network.ig_config:
      client: "{{ client_rw }}"
      revert: true
    register: result
  - ansible.builtin.debug:
      var: result

  - name: Change the unit name
    community.network.ig_config:
      client: "{{ client_rw }}"
      modify: true
      table: misc.unitname
      columns:
        unitname: "Test Ansible"
    register: result
  - ansible.builtin.debug:
      var: result

  - name: Add a DNS server
    community.network.ig_config:
      client: "{{ client_rw }}"
      add: true
      table: misc.dns_servers
      columns:
        server: 192.168.1.21
    register: result
  - ansible.builtin.debug:
      var: result

  - name: Add a DNS server
    community.network.ig_config:
      client: "{{ client_rw }}"
      add: true
      table: misc.dns_servers
      columns:
        server: 192.168.1.22
    register: result
  - ansible.builtin.debug:
      var: result

  - name: Add a DNS server
    community.network.ig_config:
      client: "{{ client_rw }}"
      add: true
      table: misc.dns_servers
      columns:
        server: 192.168.1.23
    register: last_dns
  - ansible.builtin.debug:
      var: last_dns

  - name: Modify the last added DNS server
    community.network.ig_config:
      client: "{{ client_rw }}"
      modify: true
      table: misc.dns_servers
      rowid: "{{ last_dns['add'][0]['id'] }}"
      columns:
        server: 192.168.1.24
    register: result
  - ansible.builtin.debug:
      var: result

  - name: Return the last added DNS server
    community.network.ig_config:
      client: "{{ client_rw }}"
      get: true
      table: misc.dns_servers
      rowid: "{{ last_dns['add'][0]['id'] }}"
    register: result
  - ansible.builtin.debug:
      var: result

  - name: Remove last added DNS server
    community.network.ig_config:
      client: "{{ client_rw }}"
      delete: true
      table: misc.dns_servers
      rowid: "{{ last_dns['add'][0]['id'] }}"
    register: result
  - ansible.builtin.debug:
      var: result

  - name: Return the all rows from table misc.dns_servers
    community.network.ig_config:
      client: "{{ client_rw }}"
      get: true
      table: misc.dns_servers
    register: result
  - ansible.builtin.debug:
      var: result

  - name: Remove remaining DNS servers
    community.network.ig_config:
      client: "{{ client_rw }}"
      delete: true
      table: misc.dns_servers
    register: result
  - ansible.builtin.debug:
      var: result

  - name: Get rowid for interface eth0
    community.network.ig_config:
      client: "{{ client_rw }}"
      return_rowid: true
      table: network.local_nets
      columns:
        interface: eth0
    register: result
  - ansible.builtin.debug:
      var: result

  - name: Store the preliminary configuration
    community.network.ig_config:
      client: "{{ client_rw }}"
      store: true
    register: result
  - ansible.builtin.debug:
      var: result

  - name: Do backup of the configuration database
    community.network.ig_config:
      client: "{{ client_rw }}"
      download: true
      store_download: true
    register: result
  - ansible.builtin.debug:
      var: result

Значения возврата

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

Ключ

Описание

add

сложное

Список, содержащий информацию о добавленной строке

Возвращается: при add равно да и успехе

data

сложное

Имена/значения столбцов

Возвращается: при успехе

Пример: {"number": "2", "server": "10.48.254.33"}

href

строка

URL REST API для добавленной строки

Возвращается: при успехе

Пример: "http://192.168.1.1/api/v1/misc/dns_servers/2"

id

целое число

Идентификатор строки

Возвращается: при успехе

Пример: 22

delete

сложное

Список, содержащий информацию о удалённой(ых) строке(ах)

Возвращается: при delete равно да и успехе

data

сложное

Имена/значения столбцов

Возвращается: при успехе

Пример: {"number": "2", "server": "10.48.254.33"}

id

целое число

Идентификатор строки

Возвращается: при успехе

Пример: 22

table

строка

Имя таблицы

Возвращается: при успехе

Пример: "misc.dns_servers"

download

сложное

База данных конфигурации и метаданные

Возвращается: при download равно да и успехе

config

строка

База данных конфигурации

Возвращается: при успехе

filename

строка

Предлагаемое имя для конфигурации

Возвращается: при успехе

Пример: "testname_2018-10-01T214040.cfg"

mimetype

строка

Тип MIME

Возвращается: при успехе

Пример: "application/x-config-database"

factory

сложное

Сообщение о статусе команды

Возвращается: при factory равно да и успехе

msg

строка

Сообщение о статусе команды

Возвращается: при успехе

Пример: "reverted the configuration to the factory configuration."

get

сложное

Список, содержащий информацию о строке(ах)

Возвращается: при get равно да и успехе

data

сложное

Имена/значения столбцов

Возвращается: при успехе

Пример: {"number": "2", "server": "10.48.254.33"}

href

строка

URL REST API для строки

Возвращается: при успехе

Пример: "http://192.168.1.1/api/v1/misc/dns_servers/1"

id

целое число

Идентификатор строки

Возвращается: при успехе

Пример: 1

table

строка

Имя таблицы

Возвращается: при успехе

Пример: "Testname"

modify

complex

Список, содержащий информацию о модифицированной строке

Возвращается: при modify yes и успехе

data

complex

Имена/значения столбцов

Возвращается: при успехе

Пример: {"number": "2", "server": "10.48.254.33"}

href

string

URL REST API для изменённой строки

Возвращается: при успехе

Пример: "http://192.168.1.1/api/v1/misc/dns_servers/1"

id

integer

Идентификатор строки

Возвращается: при успехе

Пример: 10

table

string

Название таблицы

Возвращается: при успехе

Пример: "Testname"

return_rowid

list / elements=string

Идентификатор(ы) совпавшей строки.

Возвращается: при return_rowid yes и успехе

Пример: [1, 3]

revert

complex

Сообщение о статусе команды

Возвращается: при revert yes и успехе

msg

string

Сообщение о статусе команды

Возвращается: при успехе

Пример: "reverted the configuration to the last applied configuration."

store

complex

Сообщение о статусе команды

Возвращается: при store yes и успехе

msg

string

Сообщение о статусе команды

Возвращается: при успехе

Пример: "Successfully applied and saved the configuration."

Авторы

  • Ingate Systems AB (@ingatesystems)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 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/community/network/ig_config_module.html

Spec-Zone.ru

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