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.
|
config_method
|
|
The configuration method type to use for this interface.
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 presented 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.
|
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
|
mtu
|
Default:
1500
|
The maximum transmission units (MTU), in bytes.
This allows you to configure a larger value for the MTU, in order to enable jumbo frames (any value > 1500).
Generally, it is necessary to have your host, switches, and other components not only support jumbo frames, but also have it configured properly. Therefore, unless you know what you're doing, it's best to leave this at the default.
aliases: max_frame_size
|
name
required |
|
The channel of the port to modify the configuration of.
The list of choices is not necessarily comprehensive. It depends on the number of ports that are available in the system.
The numerical value represents the number of the channel (typically from left to right on the HIC), beginning with a value of 1.
aliases: channel
|
ssid
required |
|
The ID of the array to manage. This value must be unique for each array.
|
state
|
Choices:
enabled ←
- disabled
|
When enabled, the provided configuration will be utilized.
When disabled, the IPv4 configuration will be cleared and IPv4 connectivity disabled.
|
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?
|