--- title: "Member" canonical: "https://docs.infoblox.com/space/niosmodulesansible/46006365/Member" format: markdown --- Use the `nios_member` module to create, update, or remove Infoblox NIOS members from a NIOS Grid. The following table describes the parameters you can define in the `nios_member` module: | **Parameter** | **Required/Optional** | **Description** | | --- | --- | --- | | `host_name` | Required | Specifies the host name of the member to either add, update, or remove from the NIOS instance. To update the host name in an existing member object, define a dictionary object that contains the following parameters:
- `old_name`: Specifies the existing host name that must be changed. - `new_name`: Specifies the new host name. | | `vip_setting` | *Optional | Specifies the network settings for the Grid member. Define the following subparameters:
- `address`: Specifies the IPv4 address of the Grid member. - `subnet_mask`: Specifies the subnet mask for the Grid member. - `gateway`: Specifies the default gateway for the Grid member. | | `ipv6_setting` | *Optional | Specifies the IPv6 settings for the Grid member. Define the following subparameters:
- `virtual_ip`: Specifies the IPv6 address of the Grid member. - `cidr_prefix`: Specifies the IPv6 CIDR prefix for the Grid member. - `gateway`: Specifies the IPv6 CIDR prefix for the Grid member. | | `config_addr_type` | Optional | Specifies the IP address type as `IPV4`, `IPV6`, or `BOTH`. The default value is `IPV4`. | | `enable_ha` | Optional | Enables HA if set to `True`, which means the member has two physical nodes (HA pair). | | `router_id` | Optional | Specifies the identifier of a virtual router. Provide this ID if `enable_ha` is set to `true`. This is a unique VRID number (from 1 to 255) for the local subnet. | | `lan2_enabled` | Optional | Enables the LAN2 port as an independent port when set to `true`, or as a port for failover purposes. | | `lan2_port_setting` | Optional | Specifies settings for the LAN2 port of the Grid member when set to `true`:
- `enabled`: Set to `True`, for the port to have its own IP settings. - `network_setting`: If the `enabled` parameter is set to `True`, you can define the following IPv4 network settings for the LAN2 port: - `address`: The IPv4 Address. - `subnet_mask`: The subnet mask. - `gateway`: The default gateway. - `v6_network_setting`: If the `enabled` parameter is set to `True`, you can define the following IPv6 network settings for the LAN2 port: - `virtual_ip`: The IPv6 address - `cidr_prefix`: The IPv6 CIDR prefix - `gateway`: The gateway address | | `platform` | Optional | Specifies the hardware platform. The default value is INFOBLOX. | | `node_info` | Optional | Specifies the node information list with a detailed report of statuses of operations performed on the Grid member.
- `lan2_physical_setting`: Define the following physical port settings for the LAN2 interface: - `auto_port_setting_enabled`: Enables or disables the auto port setting. - `duplex`: Specifies the port duplex. If the speed is `1000`; duplex must be FULL. - `speed`: Specifies the port speed. If speed is `1000`, duplex is FULL. - `lan_ha_port_setting`: Define the LAN or HA port settings for the node: - `ha_ip_address`: Specifies the HA IP address. - `ha_port_setting`: Specifies the physical port settings for the HA interface. - `auto_port_setting_enabled`: Enables or disables the auto port setting. - `duplex`: Specifies the port duplex. If speed is `1000`, duplex must be FULL. - `speed`: Specifies the port speed. If speed is `1000`, duplex is FULL. - `lan_port_setting`: Specifies the physical port settings for the LAN interface. Define the `auto_port_setting_enabled`, `duplex`, and `speed` parameters. - `mgmt_ipv6addr`: The public IPv6 address for the LAN1 interface. - `mgmt_lan`: The public IPv4 address for the LAN1 interface. - `mgmt_network_setting`: Defines the network settings for the MGMT port of the node. Configure the `address`, `subnet_mask`, and gateway parameters for the MGMT port. - `v6_mgmt_network_setting`: Defines the following network settings for the IPv6 MGMT port of the node. - `virtual_ip`: The IPv6 address. - `cidr_prefix`: The IPv6 CIDR prefix. - `gateway`: The default gateway address. | | `mgmt_port_setting` | Optional | Specifies settings for the member MGMT port. Define the following subparameters:
- `enabled`: Specifies whether MGMT port settings must be enabled. - `security_access_enabled`: Specifies whether the security access on the MGMT port must be enabled or not. - `vpn_enabled`: Specifies whether VPN on the MGMT port must be enabled. | | `upgrade_group` | Optional | Specifies the name of the upgrade group to which this Grid member belongs. | | `use_syslog_proxy_setting` | Optional | Specifies whether to use the syslog proxy setting. Use this flag for parameters: `external_syslog_server_enable` , `syslog_servers`, and `syslog_proxy_setting`, `syslog_size`.
The default value is `False`. | | `external_syslog_server_enable` | Optional | Specifies whether external syslog servers are enabled. | | `syslog_servers` | Optional | Specifies the list of external syslog servers. Define the following subparameters:
- `address`: Specifies the server address. - `category_list`: Specifies the list of all logging categories in syslog. - `connection_type`: Specifies the connection type for communicating with this server. You can set it to `STCP`, `TCP`, or `UDP`. - `local_interface`: Specifies the local interface through which the appliance sends syslog messages to the syslog server. The available values are `ANY`, `LAN`, or `MGMT`. The default value is `ANY`. - `message_node_id`: Identifies the node in the syslog message. The available values are `HOSTNAME`, `IP_HOSTNAME`, `LAN`, and `MGMT`. The default value is `LAN`. - `message_source`: Defines the source of syslog messages to be sent to the external syslog server. The default is `ANY`. - `only_category_list`: Sets the list of selected logging categories in syslog. The appliance forwards syslog messages that belong to the selected categories. - `port`: Specifies the port this server listens on. The default port is `514`. - `severity`: Defines the severity filter. The appliance sends log messages of the specified and higher severity to the external syslog server. The default severity value is `DEBUG`. | | `pre_provisioning` | Optional | Specifies the pre-provisioning information. Define the following subparameters:
- `hardware_info`: Specifies an array of structures that describe the hardware being pre-provisioned. - `hwmodel`: Hardware model. - `hwtype`: Hardware type. - `licenses`: Specifies an array of license types. | | `create_token` | Optional | Specifies the flag for initiating a create token request for pre-provisioned members. The default value is `false`. | | `master_candidate` | Optional | Determines whether a member must be set as Grid Master Candidate. Set one of the following values:
- `true`: Sets a member as a Grid Master Candidate. - `false`(default): Sets a Grid Master Candidate as a member. A member continues to remain a member. | | `extattrs` | Optional | Specifies extensible attributes for the member object. | | `state` | Optional | Specifies the state of the member instance on the NIOS server. Set one of the following values:
- `present` (default): Configures the record. - `absent`: Removes the record. | | `comment` | Optional | Describes the Member object. | | `provider` | Required | Defines the details of the connection:
- `host`: The DNS host name or IP address to connect to the remote instance of NIOS. - `username`: The user name to use for authenticating the connection to the remote instance. - `password`: The 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 *[NIOS Modules for Ansible Collections](https://infoblox-docs.atlassian.net/wiki/spaces/niosmodulesansible/pages/44525470)* topic. | | `connection` | Required | The `nios_member` module must be run locally. | > ⚠️ **Note** > ⚠️ > ⚠️ *When creating a member instance, you must specify either the `vip_setting` or the `ipv6_setting` parameter. ## Examples `name:Add a member to the grid with IPv4 address` `infoblox.nios_modules.nios_member:` `  host_name: member01.localdomain` `  vip_setting:` `    - address: 192.168.1.100` `      subnet_mask: 255.255.255.0` `      gateway: 192.168.1.1` `  config_addr_type: IPV4` `  platform: VNIOS` `  comment: "Created by Ansible"  state: present` `  provider:` `    host: ` `    username: ` `    password: ` `connection: local` `name: Add a HA member to the grid` `infoblox.nios_modules.nios_member:` `  host_name: memberha.localdomain` `  vip_setting:` `    - address: 192.168.1.100` `      subnet_mask: 255.255.255.0` `      gateway: 192.168.1.1` `  config_addr_type: IPV4` `  platform: VNIOS` `  enable_ha: true` `  router_id: 150` `  node_info:` `    - lan_ha_port_setting:` `       - ha_ip_address: 192.168.1.70` `         mgmt_lan: 192.168.1.80` `    - lan_ha_port_setting:` `       - ha_ip_address: 192.168.1.71` `         mgmt_lan: 192.168.1.81` `  comment: "Created by Ansible"` `  state: present` `  provider:` `    host: ` `    username: ` `    password: ` `connection: local` `name: update host name of a member` `infoblox.nios_modules.nios_member:` ` host_name: {old_name: block1.localdomain, new_name: member01.localdomain}` ` master_candidate: false` ` vip_setting:` ` - address: 120.0.0.25` ` subnet_mask: 255.255.255.0` ` gateway: 120.0.0.1` ` config_addr_type: IPV4` ` platform: VNIOS` ` comment: Created with Ansible` ` extattrs: {'Site':'HQ'}` ` state: present` ` provider: nios_provider:` ` host: 10.34.10.724` ` username: admin` ` password: cloudadmin` `connection: local`