Try SpotterConfigure Infoblox NIOS members
| "added in version" 2.8 of ansible.builtin"
Authors: Krishna Vasudevan (@krisvasudevan)
preview | supported by certified
pipInstall with pip install ansible==2.9.25
Adds and/or removes Infoblox NIOS servers. This module manages NIOS C(member) objects using the Infoblox WAPI interface over REST.
- name: add a member to the grid with IPv4 address
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: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: add a HA member to the grid
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: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: update the member with pre-provisioning details specified
nios_member:
name: member01.localdomain
pre_provisioning:
- hardware_info:
- hwmodel: IB-VM-820
hwtype: IB-VNIOS
licenses:
- dns
- dhcp
- enterprise
- vnios
comment: "Updated by Ansible"
state: present
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: remove the member
nios_member:
name: member01.localdomain
state: absent
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
state:
choices:
- present
- absent
default: present
description:
- Configures the intended state of the instance of the object on the NIOS server. When
this value is set to C(present), the object is configured on the device and when
this value is set to C(absent) the value is removed (if necessary) from the device.
comment:
description:
- A descriptive comment of the Grid member.
extattrs:
description:
- Extensible attributes associated with the object.
platform:
default: INFOBLOX
description:
- Configures the Hardware Platform.
provider:
description:
- A dict object containing connection details.
suboptions:
host:
description:
- Specifies the DNS host name or address for connecting to the remote instance
of NIOS WAPI over REST
- Value can also be specified using C(INFOBLOX_HOST) environment variable.
type: str
http_request_timeout:
default: 10
description:
- The amount of time before to wait before receiving a response
- Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment
variable.
type: int
max_results:
default: 1000
description:
- Specifies the maximum number of objects to be returned, if set to a negative
number the appliance will return an error when the number of returned objects
would exceed the setting.
- Value can also be specified using C(INFOBLOX_MAX_RESULTS) environment variable.
type: int
max_retries:
default: 3
description:
- Configures the number of attempted retries before the connection is declared
usable
- Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment variable.
type: int
password:
description:
- Specifies the password to use to authenticate the connection to the remote instance
of NIOS.
- Value can also be specified using C(INFOBLOX_PASSWORD) environment variable.
type: str
username:
description:
- Configures the username to use to authenticate the connection to the remote
instance of NIOS.
- Value can also be specified using C(INFOBLOX_USERNAME) environment variable.
type: str
validate_certs:
aliases:
- ssl_verify
default: false
description:
- Boolean value to enable or disable verifying SSL certificates
- Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment variable.
type: bool
wapi_version:
default: '2.1'
description:
- Specifies the version of WAPI to use
- Value can also be specified using C(INFOBLOX_WAP_VERSION) environment variable.
- Until ansible 2.8 the default WAPI was 1.4
type: str
type: dict
enable_ha:
description:
- If set to True, the member has two physical nodes (HA pair).
type: bool
host_name:
aliases:
- name
description:
- Specifies the host name of the member to either add or remove from the NIOS instance.
required: true
node_info:
description:
- Configures the node information list with detailed status report on the operations
of the Grid Member.
suboptions:
lan2_physical_setting:
description:
- Physical port settings for the LAN2 interface.
suboptions:
auto_port_setting_enabled:
description:
- Enable or disalbe the auto port setting.
type: bool
duplex:
description:
- The port duplex; if speed is 1000, duplex must be FULL.
speed:
description:
- The port speed; if speed is 1000, duplex is FULL.
lan_ha_port_setting:
description:
- LAN/HA port settings for the node.
suboptions:
ha_ip_address:
description:
- HA IP address.
ha_port_setting:
description:
- Physical port settings for the HA interface.
suboptions:
auto_port_setting_enabled:
description:
- Enable or disalbe the auto port setting.
type: bool
duplex:
description:
- The port duplex; if speed is 1000, duplex must be FULL.
speed:
description:
- The port speed; if speed is 1000, duplex is FULL.
lan_port_setting:
description:
- Physical port settings for the LAN interface.
suboptions:
auto_port_setting_enabled:
description:
- Enable or disalbe the auto port setting.
type: bool
duplex:
description:
- The port duplex; if speed is 1000, duplex must be FULL.
speed:
description:
- The port speed; if speed is 1000, duplex is FULL.
mgmt_ipv6addr:
description:
- Public IPv6 address for the LAN1 interface.
mgmt_lan:
description:
- Public IPv4 address for the LAN1 interface.
mgmt_network_setting:
description:
- Network settings for the MGMT port of the node.
suboptions:
address:
description:
- The IPv4 Address of MGMT
gateway:
description:
- The default gateway of MGMT
subnet_mask:
description:
- The subnet mask of MGMT
v6_mgmt_network_setting:
description:
- The network settings for the IPv6 MGMT port of the node.
suboptions:
cidr_prefix:
description:
- The IPv6 CIDR prefix of MGMT
gateway:
description:
- The gateway address of MGMT
virtual_ip:
description:
- The IPv6 Address of MGMT
router_id:
description:
- Virtual router identifier. Provide this ID if "ha_enabled" is set to "true". This
is a unique VRID number (from 1 to 255) for the local subnet.
vip_setting:
description:
- Configures the network settings for the grid member.
required: true
suboptions:
address:
description:
- The IPv4 Address of the Grid Member
gateway:
description:
- The default gateway for the Grid Member
subnet_mask:
description:
- The subnet mask for the Grid Member
create_token:
default: false
description:
- Flag for initiating a create token request for pre-provisioned members.
type: bool
ipv6_setting:
description:
- Configures the IPv6 settings for the grid member.
required: true
suboptions:
cidr_prefix:
description:
- The IPv6 CIDR prefix for the Grid Member
gateway:
description:
- The gateway address for the Grid Member
virtual_ip:
description:
- The IPv6 Address of the Grid Member
lan2_enabled:
description:
- When set to "true", the LAN2 port is enabled as an independent port or as a port
for failover purposes.
type: bool
upgrade_group:
default: Default
description:
- The name of the upgrade group to which this Grid member belongs.
syslog_servers:
description:
- The list of external syslog servers.
suboptions:
address:
description:
- The server address.
category_list:
description:
- The list of all syslog logging categories.
connection_type:
default: UDP
description:
- The connection type for communicating with this server.(STCP/TCP?UDP)
local_interface:
default: ANY
description:
- The local interface through which the appliance sends syslog messages to the
syslog server.(ANY/LAN/MGMT)
message_node_id:
default: LAN
description:
- Identify the node in the syslog message. (HOSTNAME/IP_HOSTNAME/LAN/MGMT)
message_source:
default: ANY
description:
- The source of syslog messages to be sent to the external syslog server.
only_category_list:
description:
- The list of selected syslog logging categories. The appliance forwards syslog
messages that belong to the selected categories.
type: bool
port:
default: 514
description:
- The port this server listens on.
severity:
default: DEBUG
description:
- The severity filter. The appliance sends log messages of the specified severity
and above to the external syslog server.
config_addr_type:
default: IPV4
description:
- Address configuration type (IPV4/IPV6/BOTH)
pre_provisioning:
description:
- Pre-provisioning information.
suboptions:
hardware_info:
description:
- An array of structures that describe the hardware being pre-provisioned.
suboptions:
hwmodel:
description:
- Hardware model
hwtype:
description:
- Hardware type.
licenses:
description:
- An array of license types.
lan2_port_setting:
description:
- Settings for the Grid member LAN2 port if 'lan2_enabled' is set to "true".
suboptions:
enabled:
description:
- If set to True, then it has its own IP settings.
type: bool
network_setting:
description:
- If the 'enable' field is set to True, this defines IPv4 network settings for
LAN2.
suboptions:
address:
description:
- The IPv4 Address of LAN2
gateway:
description:
- The default gateway of LAN2
subnet_mask:
description:
- The subnet mask of LAN2
v6_network_setting:
description:
- If the 'enable' field is set to True, this defines IPv6 network settings for
LAN2.
suboptions:
cidr_prefix:
description:
- The IPv6 CIDR prefix of LAN2
gateway:
description:
- The gateway address of LAN2
virtual_ip:
description:
- The IPv6 Address of LAN2
mgmt_port_setting:
description:
- Settings for the member MGMT port.
suboptions:
enabled:
description:
- Determines if MGMT port settings should be enabled.
type: bool
security_access_enabled:
description:
- Determines if security access on the MGMT port is enabled or not.
type: bool
vpn_enabled:
description:
- Determines if VPN on the MGMT port is enabled or not.
type: bool
use_syslog_proxy_setting:
description:
- Use flag for external_syslog_server_enable , syslog_servers, syslog_proxy_setting,
syslog_size
type: bool
external_syslog_server_enable:
description:
- Determines if external syslog servers should be enabled
type: bool