InfrastructureEVDFProfile

An Infrastructure eVDF Profile instance contains common parameters used to bootstrap instances of eVDF (encryption enabled virtual distributed firewall).

Overview

activeController string required   filterable   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  
name string required   filterable   orderable  
NTPServerKey string
NTPServerKeyID integer
nuagePlatform enum (KVM | KVM_K8S | KVM_LXC)
proxyDNSName string required   filterable   orderable  
serviceIPv4Subnet string
standbyController string filterable   orderable  
useTwoFactor boolean

API Resource

/infrastructureevdfprofiles/id
delete get put

Parents

/infrastructureevdfprofiles
get post

Children

/infrastructureevdfprofiles/id/metadatas
get post
/infrastructureevdfprofiles/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

activeController string required   filterable   orderable  
Discussion

The IP address of the active Controller (VSC)

Charateristics

Format: free
Max length: 255
SDK attribute: activeController

description string filterable   orderable  
Discussion

A brief description of the infrastructure profile.

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

name string required   filterable   orderable  
Discussion

The name of the profile instance.

Charateristics

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

NTPServerKey string
Discussion

If set, this represents the security key for the Gateway to communicate with the NTP server (a VSC).

Charateristics

Format: free
Max length: 32
SDK attribute: NTPServerKey

NTPServerKeyID integer
Discussion

Corresponds to the key ID on the NTP server that matches the NTPServerKey value. Valid values are from 1 to 255 as specified by SR-OS and when value 0 is entered, it means that the NTP Key is not used (VSD/NSG only).

Charateristics

Max value: 255
SDK attribute: NTPServerKeyID

nuagePlatform enum
Discussion

The Hypervisor Platform

Charateristics

Allowed values: KVM, KVM_K8S, KVM_LXC
Default value: KVM
SDK attribute: nuagePlatform

proxyDNSName string required   filterable   orderable  
Discussion

The DNS name of the proxy device acting as an entry point of eVDF instances to contact VSD.

Charateristics

Format: free
SDK attribute: proxyDNSName

serviceIPv4Subnet string
Discussion

K8 Service IPv4 Subnet

Charateristics

Allowed characters: 255
Default value: 0.0.0.0/8
Format: free
Max length: 32
SDK attribute: serviceIPv4Subnet

standbyController string filterable   orderable  
Discussion

The IP address of the standby Controller (VSC)

Charateristics

Format: free
Max length: 255
SDK attribute: standbyController

useTwoFactor boolean
Discussion

A flag that indicates if two-factor is enabled or not when gateway instances inheriting from this profile are bootstrapped.

Charateristics

Default value: true
SDK attribute: useTwoFactor