Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Required/Optional

Description

name

Required

Specifies the host name with which the DHCP fixed IP address is stored for a particular MAC address.

ip_addr

Required

Specifies the IPv6 or IPv4 address of the fixed address.

mac

Required

Required for specifying an IPv4 address.
It specifies the MAC address of the IPv4 interface.

duid

Required

Required for specifying an IPv6 address.
It specifies the DUID address of the IPv6 interface.

network

Optional

Specifies the network range in which the specified IP address exists.

network_view

Optional

Specifies the name of the network view to associate with this object instance.
When a value is not specified, the default network view from NIOS is used.

options

Optional

Defines the set of DHCP options to be included as part of
the configured network instance.
This argument accepts a list of values (subparameters). When configuring the subparameters, you must define name, num, or both.

  • name: The name of the DHCP option to configure.

  • num: The number of the DHCP option to configure.

  • value (required): The value of the DHCP option specified by the name subparameter.

  • use_option: Only applies to a subset of options (see the NIOS API documentation). The default value is yes.

  • vendor_class: The name of the space with which this DHCP option is associated.

extattrs

Optional

Specifies extensible attributes for the DHCP fixed address object.

state

Optional

Specifies the state of the DHCP fixed address instance in NIOS.
Set one of the following values:

  • present (default): Configures the object.

  • absent: Removes the object.

comment

Optional

Describes the DHCP fixed IP address object.

provider

Required

Defines the details of the connection:

  • host: DNS host name or IP address to connect to the remote instance of NIOS.

  • username: User name to use for authenticating the connection to the remote instance.

  • password: Password to use for authenticating the connection to the remote instance.

For information on additional fields you can define, see the list of subparameters in the list of subparameters in the NIOS Modules for Ansible Collections topic.

connection

Required

The nios_fixed_address module must be run locally.

...