Port

A port represents specific connection point of a gateway. It can be used for internal networking, like an uplink connection or a management network. It can also be used for domain's access.

Overview

associatedEgressQOSPolicyID string
associatedRedundantPortID string
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
isResilient boolean filterable   orderable  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
physicalName string required   read only   filterable   orderable  
portType enum (ACCESS | MANAGEMENT | NETWORK) required   filterable   orderable  
status enum (INITIALIZED | MISMATCH | ORPHAN | READY)
templateID string
userMnemonic string filterable   orderable  
useUserMnemonic boolean filterable   orderable  
VLANRange string filterable  

API Resource

/ports/id
delete get put

Parents

/redundancygroups/id/ports
get post
/netconfgateways/id/ports
get post
/autodiscoveredgateways/id/ports
get
/gateways/id/ports
get post

Children

/ports/id/permissions
get post
/ports/id/metadatas
get post
/ports/id/vlans
get post
/ports/id/alarms
get
/ports/id/globalmetadatas
get post put
/ports/id/enterprisepermissions
get post
/ports/id/eventlogs
get

Members

This object has no members.

Attributes documentation

associatedEgressQOSPolicyID string
Discussion

ID of the Egress QOS Policy associated with this Vlan.

Charateristics

Format: free
SDK attribute: associatedEgressQOSPolicyID

associatedRedundantPortID string
Discussion

ID of the redundant port to which this Port instance may be associated to.

Charateristics

Format: free
SDK attribute: associatedRedundantPortID

description string filterable   orderable  
Discussion

A description of the Port

Charateristics

Format: free
Max length: 255
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

isResilient boolean filterable   orderable  
Discussion

States if this port instance is resilient (redundant). An example would be a Multi-Chassis LAG port.

Charateristics

Format: free
SDK attribute: isResilient

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

Name of the Port

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

permittedAction enum
Discussion

The permitted action to USE/EXTEND this Gateway.

Charateristics

Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
SDK attribute: permittedAction

physicalName string required   read only   filterable   orderable  
Discussion

Identifier of the Port

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: physicalName

portType enum required   filterable   orderable  
Discussion

Type of the Port. Possible values are ACCESS, NETWORK, MANAGEMENT.

Charateristics

Allowed values: ACCESS, MANAGEMENT, NETWORK
Format: free
SDK attribute: portType

status enum
Discussion

Status of the port.

Charateristics

Allowed values: INITIALIZED, MISMATCH, ORPHAN, READY
SDK attribute: status

templateID string
Discussion

The ID of the template that this Port was created from

Charateristics

Format: free
SDK attribute: templateID

userMnemonic string filterable   orderable  
Discussion

user mnemonic of the Port

Charateristics

Format: free
Max length: 255
SDK attribute: userMnemonic

useUserMnemonic boolean filterable   orderable  
Discussion

determines whether to use user mnemonic of the Port

Charateristics

Format: free
SDK attribute: useUserMnemonic

VLANRange string filterable  
Discussion

VLAN Range of the Port. Format must conform to a-b,c,d-f where a,b,c,d,f are integers between 0 and 4095.

Charateristics

Format: free
Max length: 255
SDK attribute: VLANRange