HAConfiguration
Description
This model is used for basic HA configuration and cannot be modifed once the device is configured in HA mode (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)
Supported Operations
Model Properties
Property | Required | Type | Description | |||
---|---|---|---|---|---|---|
version | False | string | A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected. | |||
name | True | string | The name of HA, configured for modeling purpose and cannot be null | |||
nodeRole | True | string | The role of the unit in HA, can be primary or secondary Field level constraints: cannot be null. (Note: Additional constraints might exist) |
|||
failoverInterface | True | object | A dedicated link between two units used for syncing in case of failover. Must be a physical interface Field level constraints: cannot be null. (Note: Additional constraints might exist) Allowed types are: [EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface] |
|||
failoverName | True | string | A logical name for the failover interface Field level constraints: cannot be null, must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
primaryFailoverIPv4 | False | object | IPv4 address of the primary failover interface Field level constraints: must be a valid IP address. (Note: Additional constraints might exist) |
|||
secondaryFailoverIPv4 | False | object | IPv4 address of the secondary failover interface Field level constraints: must be a valid IP address. (Note: Additional constraints might exist) |
|||
primaryFailoverIPv6 | False | object | IPv6 address of the primary failover interface Field level constraints: must be a valid IP address. (Note: Additional constraints might exist) |
|||
secondaryFailoverIPv6 | False | object | IPv6 address of the secondary failover interface Field level constraints: must be a valid IP address. (Note: Additional constraints might exist) |
|||
statefulFailoverInterface | True | object | A dedicated interface used to pass the connection state information during a failover Field level constraints: cannot be null. (Note: Additional constraints might exist) Allowed types are: [EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface] |
|||
statefulFailoverName | True | string | A logical name for the statefulFailover interface Field level constraints: cannot be null, must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
primaryStatefulFailoverIPv4 | False | object | IPv4 address of the primary statefulFailover interface Field level constraints: must be a valid IP address. (Note: Additional constraints might exist) |
|||
secondaryStatefulFailoverIPv4 | False | object | IPv4 address of the secondary statefulFailover interface Field level constraints: must be a valid IP address. (Note: Additional constraints might exist) |
|||
primaryStatefulFailoverIPv6 | False | object | IPv6 address of the primary statefulFailover interface Field level constraints: must be a valid IP address. (Note: Additional constraints might exist) |
|||
secondaryStatefulFailoverIPv6 | False | object | IPv6 address of the secondary statefulFailover interface Field level constraints: must be a valid IP address. (Note: Additional constraints might exist) |
|||
sharedKey | False | string | Encrypted shared key used for encryption between the failover interfaces | |||
id | False | string | A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. |