ManagementIP
Description
An object that specifies a virtual interface attached to the physical Management port. The management interface has two uses.
Open web and SSH connections to the IP address and configure the device through the interface.
The system obtains smart licensing and database updates through this IP address. (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. | |||
| ipv4Mode | False | string | An enum value for IPv4 that specifies whether to obtain address through DHCP or Static (default value). Values can be one of the following. Static - Manually configure the ip address. DHCP - Obtain the ip address from a DHCP server. |
|||
| ipv4Address | False | string | A mandatory string, if IPv6 is not provided, has 48 characters, specifies the IPv4 address for the Management Interface. The string cannot have HTML tags. Field level constraints: must be a valid IP address. (Note: Additional constraints might exist) |
|||
| ipv4NetMask | False | string | A mandatory string, if IPv4 address is provided, specifies the IPv4 Netmask for Management Interface. This specifies the network part of the ipv4 address. The string cannot have HTML tags. Field level constraints: must be a valid netmask. (Note: Additional constraints might exist) |
|||
| ipv4Gateway | False | string | A mandatory string, if IPv4 address is provided, specifies the IPv4 gateway for the Management Interface. The gateway determines how the system can reach the internet to obtain smart licenses, database updates and to reach the management DNS and NTP servers. The string cannot have HTML tags. Field level constraints: must be a valid IP address. (Note: Additional constraints might exist) |
|||
| ipv6Mode | False | string | A mandatory enum value, if IPv6 address is provided, specifies whether to obtain address through DHCP or Static (default value). Values can be one of the following. Static - Manually configure the ip address. DHCP - Obtain the ip address from a DHCP server. |
|||
| ipv6Address | False | string | An optional string, if IPv4 address is provided, up to 128 bits normally represented by groups of 16 bits, specifies the IPv6 address for the Management Interface. Another way of representing 128 bit address is to drop the first consecutive sequence of zero groups. The string cannot have HTML tags. Field level constraints: must be a valid IP address. (Note: Additional constraints might exist) |
|||
| ipv6Prefix | False | integer | A mandatory integer object, if IPv6 address is provided, specifies the IPv6 prefix for Management Interface. This number specifies the length of the network part of the address. | |||
| ipv6Gateway | False | string | A mandatory string, if IPv6 address is provided, specifies the IPv6 gateway for the Management Interface. The gateway determines how the system can reach the internet to obtain smart licenses, database updates and to reach the management DNS and NTP servers. The string cannot have HTML tags. Field level constraints: must be a valid IP address. (Note: Additional constraints might exist) |
|||
| mtu | True | integer | MTU value of the Management interface. Field level constraints: cannot be null, must be between 68 and 1500 (inclusive). (Note: Additional constraints might exist) |
|||
| dhcpServerEnabled | False | boolean | A boolean value, TRUE (the default) or FALSE. The value TRUE enables DHCP server on the Management Interface, so that directly connected clients can obtain their addresses from the DHCP pool. FALSE disables the DHCP server on Management Interface. | |||
| dhcpServerAddressPool | False | string | A string which specifies the range of IP addresses that DHCP server can use to assign ip addresses. Field level constraints: must be a valid IP address or IP address range. (Note: Additional constraints might exist) |
|||
| linkState | False | string | An enum value that specifies whether the Physical Interface link state is UP or DOWN (the default). The values can be one of the following. UP - Enables the Physical Interface Link state to UP. DOWN - Enables the Physical interface Link state to DOWN. |
|||
| routeInternally | True | boolean | A mandatory boolean value, TRUE (the default) or FALSE. The value TRUE combined with static IP mode enables the management operations like system updates through data Interfaces. If it combines with DHCP IP mode, management operations will go through data interface only if management interface fails to acquire a gateway. The value FALSE uses the management interface to get the updates and management activities on the Secure Firewall device manager. Field level constraints: cannot be null. (Note: Additional constraints might exist) |
|||
| 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. | |||