connectionendpoints
No description available
csnatpools
Customer Alias IP range to be used in provider domain. This pool is used to map customer private IPs from customer domain to customer public IPs in provider domain.
ctranslationmaps
1:1 mapping of customer private IPs in customer domain to customer alias (public) IPs in provider domain and N:1 mapping to customer alias SPAT IP in the provider domain.
customproperties
Developed in the context of the Uplink Connection on the NSG, this API could be used for other types of objects. It is used as a collection of name-value (or key-value) pairs for custom attributes that could be used to enrich existing class instances.
ducgroupbindings
No description available
ducgroups
No description available
firewallacls
No description available
firewallrules
No description available
networkperformancemeasurements
Network Performance Measurement is a container for group of applications and monitor scopes
nexthops
This represents a /32 IPv4 address as the next-hop. In the future can be a /128 IPv6 address.
nsggroups
No description available
policyentries
No description available
policyobjectgroups
No description available
policystatements
No description available
psnatpools
Provider alias IP range to map provider private IPs from provider domain to provider public IPs in the customer domain.
pspatmaps
No description available
ptranslationmaps
1:1 mappings of private IPs in provider domain to the provider alias (public) IPs in customer domain and N:1 mappings of a collection of provider private IPs to a provider alias IP into the customer domain.
spatsourcespools
The list of source IPs from the provider domain to be SPATed.
sshkeys
No description available
trunks
Trunk is an object that is an aggregator of sub-vports corresponding to segmentation-ids (vlans) in a trunk
underlays
No description available
vias
No description available

alarm

alarms
The alarm API allows the management of system alarms.
allalarms
The alarm API allows the management of system alarms.

appd

links
This object represents the link between a source and destination domain in service chaining

bgp

bgpneighbors
No description available
bgpprofiles
missing documentation.

certificate

certificates
This object represents a X509 Certificate Request

cms

cms
Object that identifies a cloud management system.

common

aggregatemetadatas
Metadata associated to a entity
globalmetadatas
Metadata associated to a entity.
metadatas
Metadata associated to a entity.
sites
Remote Site info.

container

containerinterfaces
Read only API that can retrieve the container interface associated with a domain, zone or subnet for mediation created container's for REST created container interfaces you need to set the additional proxy header in http request : X-Nuage-ProxyUservalue of the header has to be either :1) enterpriseName@UserName (example :bob@Alcatel Lucent), or 2) external ID of user in VSD, typically is UUID generally decided by the CMS tool in questionUser needs to have CMS privileges to use proxy user header.
containerresync
Provide information about the state of a container resync request.
containers
Read only API that can retrieve the containers associated with a domain, zone or subnet for mediation created containers for REST created containers you need to set the additional proxy user header in http request : X-Nuage-ProxyUservalue of the header has to be either :1) enterpriseName@UserName (example : Alcatel Lucent@bob), or 2) external ID of user in VSD, typically is UUID generally decided by the CMS tool in questionUser needs to have CMS privileges to use proxy user header.

eventlog

eventlogs
The API retrieves the events related to a particular entity

gateway

addressmaps
Defines an address mapping between a private IP and a port with a public IP address and port.
autodiscoveredgateways
Represents Auto discovered Gateway.
bootstrapactivations
NSG Gateway initiated Bootstrap Activation
bootstraps
Gateway bootstrap details.
enterprisepermissions
Represents Enterprise Permission for a CSP entity.
gateways
Represents Gateway object.
gatewaytemplates
Represents Gateway Template object.
infraconfig
Represents Infrastructure Config
locations
Gateway location details.
natmapentries
Defines a MAP between the private ip and public ip.
nsredundantports
Represents a Port under a particular gateway object or redundant group object.
overlayaddresspools
The address pool the public IP of the PAT/NAT entries belong too.
overlaypatnatentries
No description available
patipentries
missing documentation.
patmappers
missing documentation.
patnatpools
Represents a PAT NAT Pool object.
portmappings
missing documentation.
ports
Represents Port under a particular gateway object or redundant group object.
porttemplates
Represents a Port Template object under a given gateway template object.
redundancygroups
Represents Redundant Group formed by two Gateways.
services
Represents a WAN Service Object.
vlans
Represents VLAN object under a given Port object.
vlantemplates
Represents VLAN Template under a Port Template object.
vsgredundantports
Represents a redundant Port under a particular gateway object or redundant group object.

ike

ikecertificates
Represents an IKE Trusted Certificate
ikeencryptionprofiles
Represents an IKE Profile
ikegatewayconfig
Represents an IKE Gateway Configuration Object
ikegatewayconnections
Represents an IKE Gateway Connection object
ikegatewayprofiles
Represents an IKE Gateway
ikegateways
Represents an IKE Gateway
ikepsks
Represents an IKE Pre Shared Key
ikesubnets
Represents an IKE Subnet (remote side)

infrastructure

infrastructureaccessprofiles
Represents an Infrastructure Access Profile
infrastructuregatewayprofiles
Represents Infrastructure Gateway Profile
infrastructurevscprofiles
Represents an Infrastructure VSC Profile.

ipsec

enterprisesecureddatas
This object represents the secured data object under the enterprise
enterprisesecurities
This object represents the enterprise security
gatewaysecureddatas
This object represents the secured data object under the gateway
gatewaysecurities
This object represents the gateway security object

job

jobs
Represents JOB entity. The job API accepts a command and parameters and executes the job and returns the results. Jobs API are typically used for long running tasks.

keyserver

groupkeyencryptionprofiles
Represents a Group Key Profile
keyservermembers
Represents a KeyServer
keyservermonitorencryptedseeds
Represents a Keyserver Monitor Encrypted Seed Snapshot.
keyservermonitors
Represents a Keyserver Monitor Snapshot.
keyservermonitorseeds
Represents a Keyserver Monitor Seed Snapshot.
keyservermonitorseks
Represents a Keyserver Monitor SEK Snapshot.
keyservernotifications
KeyServer Notification - Create one of these transient objects to push an event to the KeyServer

licensemgmt

licenses
Enables retrieval/modification and creation of license files. Most of the attributes are retrieved from the encrypted license. The create API simply provides the encrypted license that is in base64 format.
licensestatus
No description available

network

addressranges
This is the definition of a Address Range associated with a Network.
dhcpoptions
Allows the definition of one or more DHCP options that will be provided to all VMs that are associated with a given domain. DHCP options are provided as Type- Length-Value (TLV). There is no validation by VSD on whether these options are valid or not. It is up to the user to guarantee that the options make sense for their application.
domains
This object is used to manipulate domain state. A domain corresponds to a distributed Virtual Router and Switch.
domaintemplates
Domains in VSD are created from domain templates. This object provides the definition of the Domain Template.
enterprisenetworks
Administrators of an enterprise can define macros that are set of IP addresses that identify enterprise networks. These macros can be used in the ACL definitions by network designers and other users to identify access restrictions towards specific enterprise networks.
floatingips
Floating IP that is associated to a Domain. This floating IP could be used in the VM interface for NAT functionality.
ipreservations
This is the definition of a IP Bindings associated with in a Network.
l2domains
This is the definition of a l2 domain associated with a Enterprise.
l2domaintemplates
L2 Domain in VSD as derived by templates. This object describes the L2 Domain template.
multicastchannelmaps
This is the definition of a MultiCast Channel Map.
multicastlists
This is the definition of a MultiCast Channel List.
multicastranges
This is the definition of a MultiCast Range associated with a MultiCast Channel Map.
networklayout
This API defines the AS number that should be used in the data center as well as the IP address of the route reflector.
networkmacrogroups
Administrators of an enterprise can define macros that are set of IP addresses that identify enterprise networks. These macros can be used in the ACL definitions by network designers and other users to identify access restrictions towards specific enterprise networks.
publicnetworks
Similar to the enterprise macros, the public network macro allows an administrator of an enterprise to define range of subnets that can be used by users in the ACL definition.
routingpolicies
No description available
sharednetworkresources
This defines shared infrastructure resources that are created by user with CSPROOT role. These resources can be used by all the enterprises in the data center for various purposes. Examples of shared resources are public subnet, floating subnet, public L2 domain.
staticroutes
Static routes allow end users to define how traffic is routed through the dVRS in addition to the routes learned by VSC through VM activation. By using static routes, end users can define for example that all traffic with a destination address towards a specific subnet must be forwarded to a specific VM attached in the dVRS and this VM could be a firewall
subnets
This is the definition of a subnet associated with a Zone.
subnettemplates
As domain and zone objects, subnet objects are created in VSD as derived by templates. This object describes the subnet template.
uplinkconnections
No description available
uplinkroutedistinguishers
Represents a network port uplink route distinguisher value.
vpnconnections
This is the definition of a VPN Connect which holds the PE service assocaition with a DOMAIN.
zones
The zone is a collection of subnets attached to a domain. The zone concept enables the definition of policies for collections of subnets.
zonetemplates
As in domains and subnets, zones are derived from templates. This object provides the definition of the template.

nsg

lteinformations
Contains information about the LTE dongle plugged in USB port on NSG. This would have information like - Modem Manufacturer, Model Number, Subscriber Number, Operator etc. This information could vary from vendor to vendor.
nsgateways
Represents a Network Service Gateway.
nsgatewaytemplates
Represents a Network Service Gateway Template.
nsginfos
Device information coming from the NSG
nsgredundancygroups
Represents Redundant Group formed by two VNS Gateways.
nsports
Represents a Port of a particular NS Gateway object.
nsporttemplates
Represents Port Template object under a given gateway template object.
ssidconnections
An SSID Connection instance represents an SSID defined on a WiFi interface. One SSID Connection is required per SSID created on a WiFi Card/Port.
wirelessports
Represents a wireless (WiFi) interface configured on a Network Service Gateway (NSG) instance. The WirelessPort instance may map to a physical WiFi card or a WiFi port.
wirelessporttemplates
Template of a Wireless Interface that may exist on a NSGateway Template instance. Instantiation of NSG Template will result in the creation of a Wireless Port instance on the NSG instance. Parameters defined on the template will be used to polulate the attributes on the Wireless Port instance inheriting from the template.
zfbautoassignments
ZFB Enterprise Auto Assignment
zfbrequests
A ZFB Request from an NSG

perfrouting

applicationbindings
No description available
applicationperformancemanagementbindings
Association object for maintaining the priority of AppliationGroup(s) associated to a Domain
applicationperformancemanagements
Application Group is a container for group of applications
applications
represents a application with L4/L7 classification
l7applicationsignatures
Layer 7 ApplicationType , these are auto created as part of VSD bringup
networkperformancebindings
No description available
performancemonitors
No description available

policy

dscpforwardingclassmappings
Provides the definition of a single DSCP to a Forwarding class mapping that is part of a Table used in QoS policies.
dscpforwardingclasstables
Provides the definition of a table that holds multiple DSCP to Forwarding class mappings. Used in QoS policies.
egressdomainfloatingipaclentrytemplates
Defines the template of Egress Domain ACL Template entries
egressdomainfloatingipacltemplates
Defines the template for an Domain Floating IP ACL
egressfloatingipaclentrytemplates
Defines the template of Egress ACL Template entries
egressfloatingipacltemplates
Defines the template for an Floating IP ACL
policydecisions
This object is a read only object that provides the policy decisions for a particular VM interface.

policy/acl

egressaclentrytemplates
Defines the template of Egress ACL Template entries
egressacltemplates
Defines the template for an Egress ACL.
egressadvfwdentrytemplates
Defines the template of Egress Advanced Forwarding entries
egressadvfwdtemplates
Defines the template for an Egress Advanced Forwarding.
ingressaclentrytemplates
Defines the template of Ingress ACL entries
ingressacltemplates
Defines the template for an Ingress ACL.
ingressadvfwdentrytemplates
Defines the template of Ingress Advanced Forwarding entries
ingressadvfwdtemplates
Defines the template for an Ingress Advanced Forwarding.
ingressexternalserviceentrytemplates
Defines the template of Ingress External Service ACL entries
ingressexternalservicetemplates
Defines the template for an Ingress External Service Acls.

policy/qos

egressqospolicies
The object manipulates Egress QoS parameters attached to a Access Port / VLAN or Network port.
qos
The object manipulates the QoS parameters attached to a domain, zone, or subnet.
ratelimiters
Rate Limiter object that contains peak, burst and cir. It can be associated with Egress QOS policy objects.

stats

bulkstatistics
Retrieves the statistics for a particular Entity and its immediate child entity.
ltestatistics
Retrieves statistics for LTE uplink
statistics
Retrieves the statistics for a particular domain, zone, subnet, or VM.
statisticscollector
Identifies the IP address of the stats collector entity that must be used.
statisticspolicies
Defines the frequency of statistics collection associated with an object.
tcas
Provides the definition of the Threshold Control Alarms.

sysmon

bgppeers
Encapsulates the BGP peer information for system monitor entity.
components
System Monitoring details for components of VSD system.
hscs
System Monitoring details for hardware service controllers.
monitoringports
Encapsulates the port information for system monitoring entity.
monitorscopes
This class tries to define the scope of probe (the NSGs between which the probe needs) to run.
multinicvports
Encapsulates the Multi NIC VPort information for system monitoring entity.
vrss
System Monitoring details for VRS connected to VSC or HSC
vscs
System Monitoring details for VSC.
vsds
System Monitoring details for VSD.
vsps
System Monitoring details for VSP.

systemconfig

systemconfigs
The system configuration which can be dynamically managed using rest api.

usermgmt

avatars
Avatar
enterpriseprofiles
Enterprise profile, used to store an enterprise's policies, quota etc.
enterprises
Definition of the enterprise object. This is the top level object that represents an enterprise.
groups
Identifies a group within an enterprise
ldapconfigurations
Configuration of LDAP parameters associated with an enterprise. This will enable authentication through an external LDAP server for this enterprise.
me
Object that identifies the user functions
permissions
Represents Permitted action on an entity for a group.
users
Object that identifies the user functions.

vm

diskstats
Encapsulates the disk usage metrics for system monitor entity.
resync
Provide information about the state of a VM resync request.
vminterfaces
Read only API that can retrieve the VM interface associated with a domain, zone or subnet for mediation created VM's for REST created VM interfaces you need to set the additional proxy header in http request : X-Nuage-ProxyUservalue of the header has to be either :1) enterpriseName@UserName (example :bob@Alcatel Lucent), or 2) external ID of user in VSD, typically is UUID generally decided by the CMS tool in questionUser needs to have CMS privileges to use proxy user header.
vms
Read only API that can retrieve the VMs associated with a domain, zone or subnet for mediation created VM's for REST created VM's you need to set the additional proxy user header in http request : X-Nuage-ProxyUservalue of the header has to be either :1) enterpriseName@UserName (example : Alcatel Lucent@bob), or 2) external ID of user in VSD, typically is UUID generally decided by the CMS tool in questionUser needs to have CMS privileges to use proxy user header.

vmware

autodiscoveredclusters
No description available
autodiscovereddatacenters
No description available
autodiscoveredhypervisors
No description available
eamconfigs
The EAM solution configuration.
vcenterclusters
VCenter Clusters.
vcenterdatacenters
VCenter DataCenters.
vcenterhypervisors
Host or Hypervisors.
vcenters
Represents a VCenter.
vrsaddressranges
This is the definition of a Address Range associated with a VRS.
vrsconfigs
Default VRS Configuration parameters
vrsmetrics
No description available
vrsredeploymentpolicies
No description available

vnf

vnfcatalogs
Represents VNF Catalog
vnfdescriptors
Represent Virtual Network Function Descriptor Object
vnfinterfacedescriptors
Represent VNF interface descriptor
vnfinterfaces
Represent VNF interface, This can not be created directly, it will be generated from VNF Interface Descriptor when VNF instance is created.
vnfmetadatas
No description available
vnfs
Represent a VNF instance

vport

brconnections
No description available
bridgeinterfaces
Provides information for each bridge interface.
demarcationservices
No description available
hostinterfaces
Provides information for each host interface.
mirrordestinations
Represents a mirror destination.
overlaymirrordestinations
No description available
overlaymirrordestinationtemplates
No description available
policygroups
PolicyGroup is group of policys on which a user can policies like ACL, QoS, etc.
policygrouptemplates
PolicyGroupTemplate represents the template of a policy group object. PolicyGroup is group of vports on which a user can policies like ACL, QoS, etc.
redirectiontargets
A group/collection of vports that belong to the same domain.
redirectiontargettemplates
Template for a vporttag. It can be created only at the template level and available for all instances.
virtualips
Virtual IP address.
vportmirrors
VPort Mirror represents the relationship between a vport and a mirror destination.
vports
VPorts are a new level in the domain hierarchy, intended to provide more granular configuration than at subnet, and also support a split workflow, where the vPort is configured and associated with a VM port (or gateway port) before the port exists.