dellemc.openmanage.ome_application_network_address модуль — Обновляет конфигурацию сети в OpenManage Enterprise

Примечание

Этот модуль является частью коллекции dellemc.openmanage (версия 9.7.0).

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

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

Чтобы использовать его в книге задач, укажите: dellemc.openmanage.ome_application_network_address.

Новое в dellemc.openmanage 2.1.0

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

Описание

Этот модуль позволяет настроить сеть DNS и IPV4 или IPV6 в OpenManage Enterprise.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлен в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, используемый для проверки.
dns_configuration словарь	Настройки системы доменных имён (DNS).
dns_domain_name строка	Статическое имя домена DNS Применимо, когда use_dhcp_for_dns_domain_name ложно.
dns_name строка	Имя DNS для hostname Применимо, когда register_with_dns истинно.
register_with_dns булево	Регистрация/удаление dns_name в DNS-сервере. Этот параметр не может быть обновлён при изменении конфигурации VLAN. Выбори: `false` `true`
use_dhcp_for_dns_domain_name булево	Получение dns_domain_name с помощью DHCP-сервера. Выбори: `false` `true`
enable_nic булево	Включение или отключение конфигурации сетевой карты (NIC). Выбори: `false` `true` ← (по умолчанию)
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
interface_name строка	При наличии нескольких интерфейсов, изменения сетевой конфигурации могут быть применены к отдельному интерфейсу с помощью имени NIC. Если этот параметр не указан, по умолчанию выбирается основной интерфейс.
ipv4_configuration словарь	Конфигурация сети IPv4. Предупреждение Убедитесь, что у вас есть альтернативный интерфейс для доступа к OpenManage Enterprise, так как эти параметры могут изменить текущий IPv4-адрес для hostname.
enable булево / обязательно	Включение или отключение доступа к сети с использованием IPv4. Выбори: `false` `true`
enable_dhcp булево	Включение или отключение автоматического запроса IPv4-адреса у сервера DHCP. Если параметр enable_dhcp имеет значение «истина», OpenManage Enterprise получает конфигурацию IP (IPv4-адрес, маску подсети и шлюз) с DHCP-сервера в существующей сети. Выбори: `false` `true`
static_alternate_dns_server строка	Статический альтернативный DNS-сервер IPv4 Этот параметр применим, когда use_dhcp_for_dns_server_names ложно.

END_OF_DOCUMENT_MARKER

enable boolean / обязательно	Включить или отключить доступ к сети с использованием IPv6. Варианты: `false` `true`
enable_auto_configuration boolean	Включить или отключить автоматический запрос получения адреса IPv6 от сервера DHCPv6 или рекламных сообщений маршрутизатора (RA). Если enable_auto_configuration имеет значение true, OME извлекает конфигурацию IP-адреса IPv6, префикс и шлюз с сервера DHCPv6 в существующей сети. Варианты: `false` `true`
static_alternate_dns_server строка	Статический альтернативный сервер DNS IPv6 Этот параметр применим, когда use_dhcp_for_dns_server_names имеет значение false.
static_gateway строка	Статический шлюз IPv6 Этот параметр применим, когда enable_auto_configuration имеет значение false.
static_ip_address строка	Статический адрес IPv6 Этот параметр применим, когда enable_auto_configuration имеет значение false.
static_preferred_dns_server строка	Предпочтительный статический сервер DNS IPv6 Этот параметр применим, когда use_dhcp_for_dns_server_names имеет значение false.
static_prefix_length целое число	Статическая длина префикса IPv6 Этот параметр применим, когда enable_auto_configuration имеет значение false.
use_dhcp_for_dns_server_names boolean	Этот параметр позволяет автоматически запрашивать и получать адрес IPv6 сервера DNS от сервера DHCP. Этот параметр применим, когда enable_auto_configuration имеет значение true. Варианты: `false` `true`
management_vlan словарь	Конфигурация VLAN. Эти настройки применимы для OpenManage Enterprise Modular.
enable_vlan boolean / обязательно	Включить или отключить VLAN для управления. Конфигурация VLAN не может быть обновлена, если поле register_with_dns в dns_configuration имеет значение true. ПРЕДУПРЕЖДЕНИЕ Убедитесь, что сетевой кабель подключен к соответствующему порту после внесения изменений в конфигурацию VLAN. В противном случае изменения конфигурации могут не вступить в силу. Варианты: `false` `true`
vlan_id целое число	Идентификатор VLAN. Этот параметр применим, когда enable_vlan имеет значение true.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=пароль
port целое число	Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
reboot_delay целое число	Время в секундах, после которого настройки применяются. Этот параметр необязателен.
timeout целое число добавлено в dellemc.openmanage 5.0.0	Таймаут уровня сокета в секундах. По умолчанию: `30`
username строка	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. Пример: export OME_USERNAME=имя_пользователя
validate_certs boolean добавлено в dellemc.openmanage 5.0.0	Если `false`, сертификаты SSL не будут проверены. Настройте `false` только на управляемых вами сайтах, где используются самозаверяющие сертификаты. До версии сборки `5.0.0`, validate_certs был `false` по умолчанию. Варианты: `false` `true` ← (по умолчанию)
x_auth_token строка добавлено в dellemc.openmanage 9.3.0	Токен аутентификации. Если x_auth_token не указан, используется переменная среды `OME_X_AUTH_TOKEN`. Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

Изменения конфигурации могут быть применены только к одному интерфейсу за раз.
Консоли управления системой могут быть недоступны некоторое время после применения изменений конфигурации.
Этот модуль поддерживает check_mode.

Примеры

---
- name: IPv4 network configuration for primary interface
  dellemc.openmanage.ome_application_network_address:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_nic: true
    ipv4_configuration:
      enable: true
      enable_dhcp: false
      static_ip_address: 192.168.0.2
      static_subnet_mask: 255.255.254.0
      static_gateway: 192.168.0.3
      use_dhcp_for_dns_server_names: false
      static_preferred_dns_server: 192.168.0.4
      static_alternate_dns_server: 192.168.0.5
    reboot_delay: 5

- name: IPv6 network configuration for primary interface
  dellemc.openmanage.ome_application_network_address:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    ipv6_configuration:
      enable: true
      enable_auto_configuration: true
      static_ip_address: 2626:f2f2:f081:9:1c1c:f1f1:4747:1
      static_prefix_length: 10
      static_gateway: 2626:f2f2:f081:9:1c1c:f1f1:4747:2
      use_dhcp_for_dns_server_names: true
      static_preferred_dns_server: 2626:f2f2:f081:9:1c1c:f1f1:4747:3
      static_alternate_dns_server: 2626:f2f2:f081:9:1c1c:f1f1:4747:4

- name: Management vLAN configuration for primary interface
  dellemc.openmanage.ome_application_network_address:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    management_vlan:
      enable_vlan: true
      vlan_id: 3344
    dns_configuration:
      register_with_dns: false
    reboot_delay: 1

- name: DNS settings
  dellemc.openmanage.ome_application_network_address:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    ipv4_configuration:
      enable: true
      use_dhcp_for_dns_server_names: false
      static_preferred_dns_server: 192.168.0.4
      static_alternate_dns_server: 192.168.0.5
    dns_configuration:
      register_with_dns: true
      use_dhcp_for_dns_domain_name: false
      dns_name: "MX-SVCTAG"
      dns_domain_name: "dnslocaldomain"

- name: Disbale nic interface eth1
  dellemc.openmanage.ome_application_network_address:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_nic: false
    interface_name: eth1

- name: Complete network settings for interface eth1
  dellemc.openmanage.ome_application_network_address:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_nic: true
    interface_name: eth1
    ipv4_configuration:
      enable: true
      enable_dhcp: false
      static_ip_address: 192.168.0.2
      static_subnet_mask: 255.255.254.0
      static_gateway: 192.168.0.3
      use_dhcp_for_dns_server_names: false
      static_preferred_dns_server: 192.168.0.4
      static_alternate_dns_server: 192.168.0.5
    ipv6_configuration:
      enable: true
      enable_auto_configuration: true
      static_ip_address: 2626:f2f2:f081:9:1c1c:f1f1:4747:1
      static_prefix_length: 10
      static_gateway: ffff::2607:f2b1:f081:9
      use_dhcp_for_dns_server_names: true
      static_preferred_dns_server: 2626:f2f2:f081:9:1c1c:f1f1:4747:3
      static_alternate_dns_server: 2626:f2f2:f081:9:1c1c:f1f1:4747:4
    dns_configuration:
      register_with_dns: true
      use_dhcp_for_dns_domain_name: false
      dns_name: "MX-SVCTAG"
      dns_domain_name: "dnslocaldomain"
    reboot_delay: 5

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

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

Ключ	Описание
error_info словарь	Подробности HTTP-ошибки. Возвращается: при HTTP-ошибке Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to update the address configuration because a dependent field is missing for Use DHCP for DNS Domain Name, Enable DHCP for ipv4 or Enable Autoconfig for ipv6 settings for valid configuration .", "MessageArgs": ["Use DHCP for DNS Domain Name, Enable DHCP for ipv4 or Enable Autoconfig for ipv6 settings for valid configuration"], "MessageId": "CAPP1304", "RelatedProperties": [], "Resolution": "Make sure that all dependent fields contain valid content and retry the operation.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}
job_info словарь	Подробности задания для обновления в случае, если версия OME >= 3.3. Возвращается: при успехе Пример: {"Builtin": false, "CreatedBy": "system", "Editable": true, "EndTime": null, "Id": 14902, "JobDescription": "Generic OME runtime task", "JobName": "OMERealtime_Task", "JobStatus": {"Id": 2080, "Name": "New"}, "JobType": {"Id": 207, "Internal": true, "Name": "OMERealtime_Task"}, "LastRun": null, "LastRunStatus": {"Id": 2080, "Name": "New"}, "NextRun": null, "Params": [{"JobId": 14902, "Key": "Nmcli_Update", "Value": "{\"interfaceName\":\"eth0\",\"profileName\":\"eth0\",\"enableNIC\":true, \"ipv4Configuration\":{\"enable\":true,\"enableDHCP\":true,\"staticIPAddress\":\"\", \"staticSubnetMask\":\"\",\"staticGateway\":\"\",\"useDHCPForDNSServerNames\":true, \"staticPreferredDNSServer\":\"\",\"staticAlternateDNSServer\":\"\"}, \"ipv6Configuration\":{\"enable\":false,\"enableAutoConfiguration\":true,\"staticIPAddress\":\"\", \"staticPrefixLength\":0,\"staticGateway\":\"\",\"useDHCPForDNSServerNames\":false, \"staticPreferredDNSServer\":\"\",\"staticAlternateDNSServer\":\"\"}, \"managementVLAN\":{\"enableVLAN\":false,\"id\":0},\"dnsConfiguration\":{\"registerWithDNS\":false, \"dnsName\":\"\",\"useDHCPForDNSDomainName\":false,\"dnsDomainName\":\"\",\"fqdndomainName\":\"\", \"ipv4CurrentPreferredDNSServer\":\"\",\"ipv4CurrentAlternateDNSServer\":\"\", \"ipv6CurrentPreferredDNSServer\":\"\",\"ipv6CurrentAlternateDNSServer\":\"\"}, \"currentSettings\":{\"ipv4Address\":[],\"ipv4Gateway\":\"\",\"ipv4Dns\":[],\"ipv4Domain\":\"\", \"ipv6Address\":[],\"ipv6LinkLocalAddress\":\"\",\"ipv6Gateway\":\"\",\"ipv6Dns\":[], \"ipv6Domain\":\"\"},\"delay\":0,\"primaryInterface\":true,\"modifiedConfigs\":{}}"}], "Schedule": "startnow", "StartTime": null, "State": "Enabled", "Targets": [], "UpdatedBy": null, "Visible": true}
msg строка	Общий статус изменения конфигурации сетевого адреса. Возвращается: всегда Пример: `"Successfully updated network address configuration"`
network_configuration словарь	Обновлённая конфигурация сетевого адреса приложения. Возвращается: при успехе Пример: {"Delay": 0, "DnsConfiguration": {"DnsDomainName": "", "DnsName": "MX-SVCTAG", "RegisterWithDNS": false, "UseDHCPForDNSDomainName": true}, "EnableNIC": true, "InterfaceName": "eth0", "Ipv4Configuration": {"Enable": true, "EnableDHCP": false, "StaticAlternateDNSServer": "", "StaticGateway": "192.168.0.2", "StaticIPAddress": "192.168.0.3", "StaticPreferredDNSServer": "192.168.0.4", "StaticSubnetMask": "255.255.254.0", "UseDHCPForDNSServerNames": false}, "Ipv6Configuration": {"Enable": true, "EnableAutoConfiguration": true, "StaticAlternateDNSServer": "", "StaticGateway": "", "StaticIPAddress": "", "StaticPreferredDNSServer": "", "StaticPrefixLength": 0, "UseDHCPForDNSServerNames": true}, "ManagementVLAN": {"EnableVLAN": false, "Id": 1}, "PrimaryInterface": true}

Авторы

Jagadeesh N V(@jagadeeshnv)

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

© 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/dellemc/openmanage/ome_application_network_address_module.html