POST - L2Connection
REST API Method: POST /api/defMTP/MTP3NAManager/MTP3NA/[string:aid_1]/L2Connections/L2Connection
Adds an L2Connection managed object.
URL:
/api/defMTP/MTP3NAManager/MTP3NA/[string:aid_1]/L2Connections/L2Connection
HTTP Method:
POST
Requires Authentication:
true
Description:
| Parameter | Description |
|---|---|
| [string:aid_1] | [MTP3NA/Type] |
| Payload(Not necessarily in order) | {"CageID":"value", "DREID":"value", "Type":"value", "MTP2ProtocolType":"value", "Context":"value", "CageName":"value", "State":"value", "MTP2ProtocolVersion":"value", "LocalIPAddress1":"value", "LocalIPAddress2":"value", "LocalPort":"value", "RemoteIPAddress1":"value", "RemoteIPAddress2":"value", "RemotePort":"value", "AssociationNumber":"value", "Heartbeat":"value", "HeartbeatInterval":"value", "RTOInitial":"value", "RTOMinimum":"value", "RTOMaximum":"value", "MaximumPathRetrans":"value", "MaximumAssocRetrans":"value", "Bundling":"value", "BundlingTO":"value", "DelayedACKTO":"value", "FastRetransThreshold":"value", "Checksum":"value", "SCTPDebugLevel":"value", "ConnectionTimeout":"value", "ConnectionRetry":"value", "CommandTimeout":"value", "CommandRetry":"value", "M2UAVariant":"value", "performActivate":"value", "performDeactivate":"value"} |
Parameters:
| Parameter Name | Required | Create | Read-Only | Data Type | Description |
|---|---|---|---|---|---|
| CageID | Yes | Yes | Yes | int32 | Cage identifier as per Hardware Manager definition. TL1Name: CAGE_ID |
| DREID | Yes | Yes | Yes | int32 | DRE to manage the L2 Connection. TL1Name: DRE_ID |
| Type | Yes | Yes | Yes | L2ModuleType | L2 Connection Protocol Type TL1Name: L2M_TYPE |
| MTP2ProtocolType | Yes | Yes | Yes | L2ModuleProtocol | Internal Protocol API Type used to interact with this L2 Connection. TL1Name: MTP2_PROT_TYPE |
| Context | No | No | Yes | string | A textual representation of the L2 Connection object. TL1Name: CONTEXT |
| CageName | No | No | No | string | A descriptive name for the L2 Connection object. TL1Name: CAGENAME |
| State | No | No | Yes | AvailState | Status of this L2 Connection. TL1Name: STATE |
| MTP2ProtocolVersion | No | No | Yes | int32 | Proprietary protocol version used to interact with this L2 Connection. TL1Name: MTP2VERSION |
| LocalIPAddress1 | No | No | No | string | Primary local address of this L2 Connection. (SCTP only) TL1Name: LOCAL_IPADDR1 |
| LocalIPAddress2 | No | No | No | string | Secondary local IP address of this L2 Connection. (SCTP only) TL1Name: LOCAL_IPADDR2 |
| LocalPort | No | No | No | int32 | Local port of L2 Connection. (SCTP only) TL1Name: LOCAL_L2PORT |
| RemoteIPAddress1 | No | No | No | string | Primary remote IP address of this L2 Connection. TL1Name: REMOTE_IPADDR1 |
| RemoteIPAddress2 | No | No | No | string | Secondary remote IP address of this L2 Connection. TL1Name: REMOTE_IPADDR2 |
| RemotePort | No | No | No | int32 | Remote port of MTP2 TL1Name: REMOTE_L2PORT |
| AssociationNumber | No | No | Yes | int32 | SCTP Association Number TL1Name: ASSOCNUM |
| Heartbeat | No | No | No | Feature | Enable or disable the Heartbeat Feature TL1Name: HB |
| HeartbeatInterval | No | No | No | int32 | Heartbeat interval (ms) TL1Name: HB_INV |
| RTOInitial | No | No | No | int32 | RTO Initial (ms) TL1Name: RTO_INIT |
| RTOMinimum | No | No | No | int32 | RTO Minimum (ms) TL1Name: RTO_MIN |
| RTOMaximum | No | No | No | int32 | RTO Maximum (ms) TL1Name: RTO_MAX |
| MaximumPathRetrans | No | No | No | int32 | Maximum path retransmissions TL1Name: MX_PATH_RETRANS |
| MaximumAssocRetrans | No | No | No | int32 | Maximum association retransmissions TL1Name: MX_ASSOC_RETRANS |
| Bundling | No | No | No | Feature | Enable or disable Bundling TL1Name: BUNDLING |
| BundlingTO | No | No | No | int32 | Bundling TO (ms) TL1Name: BUNDLING_TO |
| DelayedACKTO | No | No | No | int32 | Delayed ACK TO (ms) TL1Name: DELAYACK_TO |
| FastRetransThreshold | No | No | No | int32 | Fast Retransmit Threshold TL1Name: FAST_RETRANS_TH |
| Checksum | No | No | Yes | SCTPCheckSum | Checksum (CRC32C, ADLER32, NONE, AUTO) TL1Name: CHECKSUM |
| SCTPDebugLevel | No | No | No | int32 | SCTP debug level for association debugging TL1Name: SCTP_DBG_LVL |
| ConnectionTimeout | No | No | No | Timer | Connection timeout (ms) TL1Name: CONTIMEOUT |
| ConnectionRetry | No | No | No | Timer | Connection retry interval (ms) TL1Name: CONRETRY |
| CommandTimeout | No | No | No | Timer | Command timeout (ms) TL1Name: CMDTIMEOUT |
| CommandRetry | No | No | No | Timer | Command Retry (ms) TL1Name: CMDRETRY |
| M2UAVariant | No | No | No | M2UAFlavour | M2UA variant TL1Name: M2UA_VARIANT |
Overview
Content Tools