Connectionendpoint

SSH (Secure Shell) is used to provide secure remote console access to NSGs deployed in branch locations. For additional security, you may restrict SSH access from specific host(s) by providing a list of source IP addresses.

Overview

description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
endPointType enum (SOURCE) filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
IPAddress string filterable   orderable  
IPType enum (IPV4 | IPV6) filterable   orderable  
IPv6Address string filterable   orderable  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  

API Resource

/connectionendpoints/id
delete get put

Parents

/infrastructureaccessprofiles/id/connectionendpoints
get post

Children

/connectionendpoints/id/permissions
delete get post put
/connectionendpoints/id/metadatas
get post
/connectionendpoints/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

A description of the connection endpoint.


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

endPointType enum filterable   orderable  
Discussion

Indicates if this endpoint is the source/destination of a network connection.


Charateristics

Allowed values: SOURCE
Default value: SOURCE
SDK attribute: endPointType

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

IPAddress string filterable   orderable  
Discussion

IP Address of the end point.


Charateristics

Format: free
SDK attribute: IPAddress

IPType enum filterable   orderable  
Discussion

IPv4 or IPv6.


Charateristics

Allowed values: IPV4, IPV6
Default value: IPV4
SDK attribute: IPType

IPv6Address string filterable   orderable  
Discussion

IPv6 address of the end point.


Charateristics

Format: free
Max length: 255
SDK attribute: IPv6Address

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 connection endpoint.


Charateristics

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