InfrastructureAccessProfile

Infrastructure Access Profiles identify a set of NSG template level platform attributes specifically related to user and access control, inherited by gateways as they are instantiated.

Overview

creationDate string read only   autogenerated   orderable  
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
enterpriseID string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string required   filterable   orderable   locally unique  
owner string autogenerated  
password string required  
sourceIPFilter enum (DISABLED | ENABLED) filterable   orderable  
SSHAuthMode enum (KEY_BASED | PASSWORD_AND_KEY_BASED | PASSWORD_BASED) filterable   orderable  
userName string filterable   orderable  

API Resource

/infrastructureaccessprofiles/id
delete get put

Parents

/infrastructureaccessprofiles
get post

Children

/infrastructureaccessprofiles/id/permissions
delete get post put
/infrastructureaccessprofiles/id/metadatas
get post
/infrastructureaccessprofiles/id/globalmetadatas
get post put
/infrastructureaccessprofiles/id/connectionendpoints
get post
/infrastructureaccessprofiles/id/nsgatewaytemplates
get
/infrastructureaccessprofiles/id/sshkeys
get post

Members

This object has no members.

Attributes documentation

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

description string filterable   orderable  
Discussion

A description of the Profile instance created.

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

enterpriseID string
Discussion

Enterprise/Organisation associated with this Profile instance.

Charateristics

Format: free
SDK attribute: enterpriseID

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

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

name string required   filterable   orderable   locally unique  
Discussion

Name of the Infrastructure Access Profile

Charateristics

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

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

password string required  
Discussion

Password of the default user associated to the access profile.

Charateristics

Format: free
Min length: 8
Max length: 512
SDK attribute: password

sourceIPFilter enum filterable   orderable  
Discussion

Indicates if source based IP filtering is enabled for this access profile.

Charateristics

Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: sourceIPFilter

SSHAuthMode enum filterable   orderable  
Discussion

Indicates the authentication method used during an SSH session.

Charateristics

Allowed values: KEY_BASED, PASSWORD_AND_KEY_BASED, PASSWORD_BASED
Default value: PASSWORD_AND_KEY_BASED
SDK attribute: SSHAuthMode

userName string filterable   orderable  
Discussion

Default user name which is associated to the access profile.

Charateristics

Allowed characters: alphanumerical
Default value: nuage
Format: free
Min length: 1
Max length: 30
SDK attribute: userName