Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: POST /rest/logicalinterface/{identifier}

Page Tree
rootResource - logicalinterface

Modifies a Logical Port given a specific ID.

URL:

https://134.56.227.163/rest/logicalinterface/{identifier}

HTTP Method

POST

Requires Authentication:

true



Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ifNameYesNostringnone20 - Max LengthIs the name of the port or logical IP interface. This is a read-only attribute.
ifAliasNoNostringnone20 - Max Length Assigns an alternative name for the interface; typically configured by the SNMP-based Network Manager. This parameter is unique among all the interfaces known to the SNMP Network Manager. The value cannot have whitespace characters.
ifHwTypeNoNoEnum0Possible values:
  • 0 - IF_HW_TYPE_ETHERNET
  • 1 - IF_HW_TYPE_T1E1
  • 2 - IF_HW_TYPE_RS530
Specifies the hardware type of the interface.
ifTypeNoNoEnum0Possible values:
  • 0 - IF_TYPE_ETHERNET
  • 1 - IF_TYPE_VLAN
  • 2 - IF_TYPE_QINQ
  • 3 - IF_TYPE_BONDED
  • 4 - IF_TYPE_BRIDGE
Specifies the interface type.
ifDescriptionNoNostringnone64 - Max LengthAssigns an operator-friendly description text configured by the operator for future reference. Whitespaces are alowed.
ifNetworkingModeNoNoEnum0Possible values:
  • 0 - IF_NETWORK_MODE_SWITCH
  • 1 - IF_NETWORK_MODE_ROUTE
Specifies if the port is in switched mode or routed mode.
ifFrameTypeNoYesEnum0Possible values:
  • 0 - IF_FRAME_TYPE_ALL
  • 1 - IF_FRAME_TYPE_UNTAGGED
  • 2 - IF_FRAME_TYPE_TAGGED
Specifies the types of frames allowed when in switched mode.
ifDefaultVidNoYesstringnone8 - Max LengthSpecifies the default vlan id of the port is member. of the format (portname:default vlanid) (max= (32:4095))
ifHybridVlanNoYesstringnone256 - Max LengthSpecifies the list of vlans to be associated with a port in hybrid state. of the format "(port row id:vlanid),(port row id:vlanid)....." Range of vlanid is 1-4095
ipAddressingModeNoNoEnum0Possible values:
  • 0 - IPV4_ADDR_MODE
  • 1 - IPv6_ADDR_MODE
  • 2 - IPV4_AND_IPV6
Specifies the address mode. Currently only IPv4 is supported.
ifIpAddrAssignMethodNoYesEnum0Possible values:
  • 0 - IP_ADDRESS_STATIC
  • 1 - IP_ADDRESS_DYNAMIC
Specifies whether IP address assignment is static or dynamic (i.e. via DHCP). If dynamic is specified, certain node-level settings (i.e. NTP servers, DNS servers, and Domain Name) will be configured such that they obtain their values through DHCP. This is achieved by setting useDynamicNetSettings to true in the System managed object. In addition to this, any statically configured default routes will be removed from the system. If static is specified, and no other interface is using dynamic, the useDynamicNetSettings will be set to false and the node-level network attributes will be set to use the user configured values.
ifIPv4AddressPrimaryYesYesstringnone16 - Max LengthSpecifies the primary IP address for the interface.
ifIPv4AddressPrimaryMaskYesYesstringnone16 - Max LengthSpecifies the primary netmask for the interface.
ifIPv4ConfigSecondaryEnabledNoYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Determines if the port has a secondary IP address configuration. If this field is set to Yes, a secondary IP address and secondary Netmask must be configured.
ifIPv4AddressSecondaryNoYesstringnone16 - Max LengthSpecifies the secondary IP address for the interface.
ifIPv4AddressSecondaryMaskNoYesstringnone16 - Max LengthSpecifies the secondary netmask for the interface.
ifBridgeGroupIdYesYesint1Possible values:
  • 0 - Minimum
  • 5 - Maximum
Configures the bridge group that the Ethernet port will be part of. If it's a logical interface, it must be 0. If it's a hardware interface, the default should be 1.
ifConfiguredSpeedNoYesEnum2Possible values:
  • 0 - IF_SPEED_10
  • 1 - IF_SPEED_100
  • 2 - IF_SPEED_1000
  • 3 - IF_SPEED_AUTO
Configures autonegotiation or a specific speed for the Ethernet port. The default value should be changed only when absolutely necessary.
  • When AUTO is selected
    - the speed is automatically negotiated by the Ethernet port and the negotiated speed is reported under Negotiated Speed.
  • When AUTO is not selected
    - the Ethernet speed-auto-negotiation is disabled and the operator must configure a specific speed for the Ethernet port.
ifConfiguredDuplexityNoYesEnum2Possible values:
  • 0 - IF_DUPLEX_HALF
  • 1 - IF_DUPLEX_FULL
  • 2 - IF_DUPLEX_AUTO
Configures auto-negotiation or a specific value for the duplexity of the Ethernet port. The default value should be changed only when absolutely necessary.
  • When AUTO is selected
    - the duplexity is automatically negotiated by the Ethernet port. The negotiated duplexity is reported under Negotiated Speed.
  • When AUTO is not selected
    - the Ethernet-duplexity must be explicitly configured.
ifInterfaceIndexYesNoint0Possible values:
  • 0 - Minimum
  • 2147483647 - Maximum
Is a positive number automatically assigned by the software and is unique among all interfaces and ports in the system. This number is typically used by the SNMP Network Manager. This is a read-only attribute.
ifIPv4ConfigPrimaryEnabledNoNoEnum1Possible values:
  • 0 - IF_PRIMARY_IP_NOT_CONFIGURED
  • 1 - IF_PRIMARY_IP_CONFIGURED
Specifies whether the primary IP address is enabled or not.
OSPFDeadIntervalNoYesint40Possible values:
  • 10 - Minimum
  • 600 - Maximum
Specifies the time interval in seconds during which no hello packets are received and after which a neighbor is declared dead.
OSPFHelloIntervalNoYesint10Possible values:
  • 10 - Minimum
  • 600 - Maximum
Specifies the time interval in seconds between hello packets.
OSPFPriorityNoYesint1Possible values:
  • 0 - Minimum
  • 255 - Maximum
Specifies the router priority to determine the DR (designated router) for the network
OSPFCostNoYesint1Possible values:
  • 1 - Minimum
  • 600 - Maximum
Specifies the cost of the link-state metric in a router-LSA
OSPFRetransmitIntervalNoYesint5Possible values:
  • 5 - Minimum
  • 600 - Maximum
Specifies the time in seconds between link-state advertisement (LSA) retransmissions for adjacencies belonging to the interface
OSPFResyncTimeoutNoYesint40Possible values:
  • 10 - Minimum
  • 600 - Maximum
Specifies the time interval in seconds after which adjacency is reset if out-of-band resynchronization has not occured. The interval period starts from the time a restart signal is received from a neighbor.
aclInInstanceIDNoYesint0 Specifies the ACL instance applied on this interface for the incoming traffic.
aclOutInstanceIDNoYesint0 Specifies the ACL instance applied on this interface for the outgoing traffic.
aclForwardInstanceIDNoYesint0 Specifies the ACL instance applied on this interface for the forwarding traffic.
ifMstpStatusNoYesEnum0Possible values:
  • 0 - IF_MSTP_DISABLED
  • 1 - IF_MSTP_ENABLED
Specifies the MSTP status on this interface.

Tip
titleHelpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource

Usage Example: (about cURL | requires a session token)

Code Block
languagebash
Put code example here

Response:

Code Block
languagehtml/xml
Put Code response here