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

ca_path

path

добавлен в dellemc.openmanage 5.0.0

Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, который будет использоваться для проверки.

dns_configuration

dictionary

Параметры системы доменных имён (DNS).

dns_domain_name

string

Статическое имя домена DNS

Применяется, если use_dhcp_for_dns_domain_name имеет значение false.

dns_name

string

Имя DNS для hostname

Применяется, если register_with_dns имеет значение true.

register_with_dns

boolean

Зарегистрировать или отменить регистрацию dns_name на DNS-сервере.

Это значение нельзя изменить при изменении конфигурации VLAN.

Варианты:

• false
• true

use_dhcp_for_dns_domain_name

boolean

Получать значение dns_domain_name с помощью DHCP-сервера.

Варианты:

• false
• true

enable_nic

boolean

Включить или отключить настройку сетевой карты (NIC).

Варианты:

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

hostname

string / обязательный параметр

IP-адрес или имя хоста OpenManage Enterprise либо OpenManage Enterprise Modular.

interface_name

string

Если интерфейсов несколько, изменения сетевой конфигурации можно применить к одному интерфейсу, указав имя сетевой карты.

Если этот параметр не указан, по умолчанию выбирается основной интерфейс.

ipv4_configuration

dictionary

Конфигурация сети IPv4.

Предупреждение Убедитесь, что у вас есть альтернативный интерфейс для доступа к OpenManage Enterprise, поскольку эти параметры могут изменить текущий адрес IPv4 для hostname.

enable

boolean / обязательный параметр

Включить или отключить доступ к сети по IPv4.

Варианты:

• false
• true

enable_dhcp

boolean

Включить или отключить автоматический запрос IPv4-адреса у сервера протокола динамической конфигурации узла IPv4 (DHCP).

Если параметр enable_dhcp имеет значение true, OpenManage Enterprise получает конфигурацию IP — IPv4-адрес, маску подсети и шлюз — от DHCP-сервера в существующей сети.

Варианты:

• false
• true

static_alternate_dns_server

string

Статический альтернативный DNS-сервер IPv4

Параметр применяется, если use_dhcp_for_dns_server_names имеет значение false.

static_gateway

string

Статический адрес шлюза IPv4

Параметр применяется, если enable_dhcp имеет значение false.

static_ip_address

string

Статический адрес IPv4

Параметр применяется, если enable_dhcp имеет значение false.

static_preferred_dns_server

string

Статический предпочтительный DNS-сервер IPv4

Параметр применяется, если use_dhcp_for_dns_server_names имеет значение false.

static_subnet_mask

string

Статический адрес маски подсети IPv4

Параметр применяется, если enable_dhcp имеет значение false.

use_dhcp_for_dns_server_names

boolean

Этот параметр позволяет автоматически запросить и получить IPv4-адрес DNS-сервера от DHCP-сервера.

Параметр применяется, если enable_dhcp имеет значение true.

Варианты:

• false
• true

ipv6_configuration

dictionary

Конфигурация сети IPv6.

Предупреждение Убедитесь, что у вас есть альтернативный интерфейс для доступа к OpenManage Enterprise, поскольку эти параметры могут изменить текущий адрес IPv6 для hostname.

enable

boolean / обязательный параметр

Включить или отключить доступ к сети по IPv6.

Варианты:

• false
• true

enable_auto_configuration

boolean

Включить или отключить автоматический запрос IPv6-адреса у DHCP-сервера IPv6 или через объявления маршрутизатора (RA).

Если enable_auto_configuration имеет значение true, OME получает конфигурацию IP — IPv6-адрес, префикс и шлюз — от сервера DHCPv6 в существующей сети.

Варианты:

• false
• true

static_alternate_dns_server

string

Статический альтернативный DNS-сервер IPv6

Параметр применяется, если use_dhcp_for_dns_server_names имеет значение false.

static_gateway

string

Статический адрес шлюза IPv6

Параметр применяется, если enable_auto_configuration имеет значение false.

static_ip_address

string

Статический адрес IPv6

Параметр применяется, если enable_auto_configuration имеет значение false.

static_preferred_dns_server

string

Статический предпочтительный DNS-сервер IPv6

Параметр применяется, если use_dhcp_for_dns_server_names имеет значение false.

static_prefix_length

integer

Статическая длина префикса IPv6

Параметр применяется, если enable_auto_configuration имеет значение false.

use_dhcp_for_dns_server_names

boolean

Этот параметр позволяет автоматически запросить и получить IPv6-адрес DNS-сервера от DHCP-сервера.

Параметр применяется, если enable_auto_configuration имеет значение true.

Варианты:

• false
• true

management_vlan

dictionary

Конфигурация VLAN.

Эти параметры применяются к OpenManage Enterprise Modular.

enable_vlan

boolean / обязательный параметр

Включить или отключить VLAN для управления.

Конфигурацию VLAN нельзя обновить, если поле register_with_dns в разделе dns_configuration имеет значение true.

ПРЕДУПРЕЖДЕНИЕ После изменения конфигурации VLAN убедитесь, что сетевой кабель подключён к нужному порту. В противном случае изменения конфигурации могут не вступить в силу.

Варианты:

• false
• true

vlan_id

integer

Идентификатор VLAN.

Параметр применяется, если enable_vlan имеет значение true.

password

string

Пароль OpenManage Enterprise или OpenManage Enterprise Modular.

Если пароль не указан, используется переменная среды OME_PASSWORD.

Пример: export OME_PASSWORD=password

port

integer

HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular.

По умолчанию: 443

reboot_delay

integer

Время в секундах, по истечении которого применяются настройки.

Этот параметр необязателен.

timeout

integer

добавлен в dellemc.openmanage 5.0.0

Тайм-аут на уровне сокета в секундах.

По умолчанию: 30

username

string

Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular.

Если имя пользователя не указано, используется переменная среды OME_USERNAME.

Пример: export OME_USERNAME=username

validate_certs

boolean

добавлен в dellemc.openmanage 5.0.0

Если false, SSL-сертификаты не будут проверяться.

Настраивайте false только на контролируемых вами сайтах, где используются самоподписанные сертификаты.

До версии коллекции 5.0.0 параметр validate_certs по умолчанию имеет значение false.

Варианты:

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

x_auth_token

string

добавлен в dellemc.openmanage 9.3.0

Токен аутентификации.

Если x_auth_token не указан, используется переменная среды OME_X_AUTH_TOKEN.

Пример: export OME_X_AUTH_TOKEN=x_auth_token

error_info

dictionary

Сведения об ошибке 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

dictionary

Сведения о задании на обновление, если версия 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

string

Общий статус изменения конфигурации сетевого адреса.

Возвращается: всегда

Пример: "Successfully updated network address configuration"

network_configuration

dictionary

Обновлённая конфигурация сетевого адреса приложения.

Возвращается: при успешном выполнении

Пример: {"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}