Parameter |
Choices/Defaults |
Comments |
address
|
|
The IPv4 address to assign to the interface.
Should be specified in xx.xx.xx.xx form.
Mutually exclusive with config_method=dhcp
|
api_password
required |
|
The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
api_url
required |
|
The url to the SANtricity Web Services Proxy or Embedded Web Services API.
|
api_username
required |
|
The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
channel
|
|
The port to modify the configuration for.
The channel represents the port number (typically from left to right on the controller), beginning with a value of 1.
Mutually exclusive with name.
|
config_method
|
|
The configuration method type to use for network interface ports.
dhcp is mutually exclusive with address, subnet_mask, and gateway.
|
controller
required |
|
The controller that owns the port you want to configure.
Controller names are represented alphabetically, with the first controller as A, the second as B, and so on.
Current hardware models have either 1 or 2 available controllers, but that is not a guaranteed hard limitation and could change in the future.
|
dns_address
|
|
Primary IPv4 DNS server address
|
dns_address_backup
|
|
Backup IPv4 DNS server address
Queried when primary DNS server fails
|
dns_config_method
|
|
The configuration method type to use for DNS services.
dhcp is mutually exclusive with dns_address, and dns_address_backup.
|
gateway
|
|
The IPv4 gateway address to utilize for the interface.
Should be specified in xx.xx.xx.xx form.
Mutually exclusive with config_method=dhcp
|
log_path
|
|
A local path to a file to be used for debug logging
|
name
|
|
The port to modify the configuration for.
The list of choices is not necessarily comprehensive. It depends on the number of ports that are present in the system.
The name represents the port number (typically from left to right on the controller), beginning with a value of 1.
Mutually exclusive with channel.
aliases: port, iface
|
ntp_address
|
|
Primary IPv4 NTP server address
|
ntp_address_backup
|
|
Backup IPv4 NTP server address
Queried when primary NTP server fails
|
ntp_config_method
|
Choices:
- disable
- dhcp
- static
|
The configuration method type to use for NTP services.
disable is mutually exclusive with ntp_address and ntp_address_backup.
dhcp is mutually exclusive with ntp_address and ntp_address_backup.
|
ssh
bool |
|
Enable ssh access to the controller for debug purposes.
This is a controller-level setting.
rlogin/telnet will be enabled for ancient equipment where ssh is not available.
|
ssid
required |
|
The ID of the array to manage. This value must be unique for each array.
|
state
|
|
Enable or disable IPv4 network interface configuration.
Either IPv4 or IPv6 must be enabled otherwise error will occur.
Only required when enabling or disabling IPv4 network interface
aliases: enable_interface
|
subnet_mask
|
|
The subnet mask to utilize for the interface.
Should be specified in xx.xx.xx.xx form.
Mutually exclusive with config_method=dhcp
|
validate_certs
bool |
|
Should https certificates be validated?
|