bfdsessions
Represents the Bidirectional Forwarding Detection session that can be configured on an uplink/BR connection.
Represents the Bidirectional Forwarding Detection session that can be configured on an uplink/BR connection.
connectionendpoints
No description available
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.
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.
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.
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.
deploymentfailures
A deployment failure represents a deployment operation initiated by the VSD that resulted in a failure.
A deployment failure represents a deployment operation initiated by the VSD that resulted in a failure.
ducgroupbindings
No description available
No description available
ducgroups
No description available
No description available
firewallacls
No description available
No description available
firewallrules
No description available
No description available
infrastructureevdfprofiles
An Infrastructure eVDF Profile instance contains common parameters used to bootstrap instances of eVDF (encryption enabled virtual distributed firewall).
An Infrastructure eVDF Profile instance contains common parameters used to bootstrap instances of eVDF (encryption enabled virtual distributed firewall).
netconfsessions
Represents session between gateway and Netconf Manager, This can only be created by netconfmgr user
Represents session between gateway and Netconf Manager, This can only be created by netconfmgr user
networkperformancemeasurements
Network Performance Measurement is a container for group of applications and monitor scopes
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.
This represents a /32 IPv4 address as the next-hop. In the future can be a /128 IPv6 address.
nsgatewayssummaries
Summary information such as alarm counts, location, version, boostrap status for Network Services Gateway
Summary information such as alarm counts, location, version, boostrap status for Network Services Gateway
nsggroups
A logical group of NSG and NSG-BR instances that can be used to assign NSG-UBRs to all NSGs in the group, to provide connectivity to NSGs in disjoint underlays.
A logical group of NSG and NSG-BR instances that can be used to assign NSG-UBRs to all NSGs in the group, to provide connectivity to NSGs in disjoint underlays.
nsgroutingpolicybindings
No description available
No description available
policyentries
No description available
No description available
policyobjectgroups
Policy Object Groups are a collection of existing Network Services Gateways. These groups can be used in routing policies for domain links.
Policy Object Groups are a collection of existing Network Services Gateways. These groups can be used in routing policies for domain links.
policystatements
No description available
No description available
psnatpools
Provider alias IP range to map provider private IPs from provider domain to provider public IPs in the customer domain.
Provider alias IP range to map provider private IPs from provider domain to provider public IPs in the customer domain.
pspatmaps
No description available
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.
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.
saasapplicationgroups
Collection of SaaS Application Types.
Collection of SaaS Application Types.
spatsourcespools
The list of source IPs from the provider domain to be SPATed.
The list of source IPs from the provider domain to be SPATed.
sshkeys
No description available
No description available
trunks
A trunk is used to attach multiple vPorts to a single NIC on a VM. These sub-vPorts are separated by a segmentation identifier (currently the VLAN ID) so the attached VM can distinguish between traffic on the sub-vPorts.
A trunk is used to attach multiple vPorts to a single NIC on a VM. These sub-vPorts are separated by a segmentation identifier (currently the VLAN ID) so the attached VM can distinguish between traffic on the sub-vPorts.
underlays
No description available
No description available
alarm
alarms
The alarm API allows the management of system alarms.
The alarm API allows the management of system alarms.
allalarms
The alarm API allows the management of system alarms.
The alarm API allows the management of system alarms.
appd
links
Border router links provide a way to interconnect VNS domains in the wide-area to datacenter domains. Service chaining links allow domain leaking in order to simplify and enhance capabilities of doing service chaining and traffic steering for NFV and service-provider-grade VPN services.
Border router links provide a way to interconnect VNS domains in the wide-area to datacenter domains. Service chaining links allow domain leaking in order to simplify and enhance capabilities of doing service chaining and traffic steering for NFV and service-provider-grade VPN services.
bgp
bgpneighbors
No description available
No description available
bgpprofiles
missing documentation.
missing documentation.
certificate
certificates
This object represents a X509 Certificate Request
This object represents a X509 Certificate Request
cms
cms
Object that identifies a cloud management system.
Object that identifies a cloud management system.
common
aggregatemetadatas
Metadata associated to a entity
Metadata associated to a entity
globalmetadatas
Metadata associated to a entity.
Metadata associated to a entity.
metadatas
Metadata associated to a entity.
Metadata associated to a entity.
sites
Remote Site info.
Remote Site info.
container
containerinterfaces
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.
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.
Provide information about the state of a container resync request.
containers
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.
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
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.
Defines an address mapping between a private IP and a port with a public IP address and port.
autodiscoveredgateways
Represents Auto discovered Gateway.
Represents Auto discovered Gateway.
bootstrapactivations
NSG Gateway initiated Bootstrap Activation
NSG Gateway initiated Bootstrap Activation
bootstraps
Gateway bootstrap details.
Gateway bootstrap details.
enterprisepermissions
Represents Enterprise Permission for a CSP entity.
Represents Enterprise Permission for a CSP entity.
gatewayredundantports
Represents a redundant Port under a particular gateway object or redundant group object.
Represents a redundant Port under a particular gateway object or redundant group object.
gateways
Represents Gateway object.
Represents Gateway object.
gatewaytemplates
A gateway is your point of exit to an external network. It can be a physical or a virtual device. Gateways are templatable. You can attach gateway's VLANs to any existing host or bridge VPorts.
A gateway is your point of exit to an external network. It can be a physical or a virtual device. Gateways are templatable. You can attach gateway's VLANs to any existing host or bridge VPorts.
infraconfig
Represents Infrastructure Config
Represents Infrastructure Config
locations
Gateway location details.
Gateway location details.
natmapentries
Defines a MAP between the private ip and public ip.
Defines a MAP between the private ip and public ip.
nsredundantports
Represents a Port under a particular gateway object or redundant group object.
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.
The address pool the public IP of the PAT/NAT entries belong too.
overlaypatnatentries
No description available
No description available
patipentries
missing documentation.
missing documentation.
patmappers
PAT Mapper is a construct which will be associated with 1-N FIP Domains
PAT Mapper is a construct which will be associated with 1-N FIP Domains
patnatpools
Address Translation Pools are a range of externally routable IP addresses. User or application traffic is translated prior to being forwarded across the network.
Address Translation Pools are a range of externally routable IP addresses. User or application traffic is translated prior to being forwarded across the network.
portmappings
missing documentation.
missing documentation.
ports
Represents Port under a particular gateway object or redundant group object.
Represents Port under a particular gateway object or redundant group object.
porttemplates
Represents a Port Template object under a given gateway template object.
Represents a Port Template object under a given gateway template object.
redundancygroups
Represents Redundant Group formed by two Gateways.
Represents Redundant Group formed by two Gateways.
services
Represents a WAN Service Object.
Represents a WAN Service Object.
vlans
Represents VLAN object under a given Port object.
Represents VLAN object under a given Port object.
vlantemplates
Represents VLAN Template under a Port Template object.
Represents VLAN Template under a Port Template object.
vsgredundantports
Represents a redundant Port under a particular gateway object or redundant group object.
Represents a redundant Port under a particular gateway object or redundant group object.
ike
ikecertificates
Represents an IKE Trusted Certificate
Represents an IKE Trusted Certificate
ikeencryptionprofiles
Represents an IKE Profile
Represents an IKE Profile
ikegatewayconfig
Represents an IKE Gateway Configuration Object
Represents an IKE Gateway Configuration Object
ikegatewayconnections
Represents an IKE Gateway Connection object
Represents an IKE Gateway Connection object
ikegatewayprofiles
Define attributes of the remote IKE gateway.
Define attributes of the remote IKE gateway.
ikegateways
Represents an IKE Gateway
Represents an IKE Gateway
ikepsks
Shared secret used during the authentication phase of IKE protocol.
Shared secret used during the authentication phase of IKE protocol.
ikesubnets
Represents an IKE Subnet (remote side)
Represents an IKE Subnet (remote side)
infrastructure
infrastructureaccessprofiles
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.
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.
infrastructuregatewayprofiles
Infrastructure Gateway Profiles are gateway-level platform attributes inherited by gateways as they are instantiated, connecting them to Nuage management infrastructure.
Infrastructure Gateway Profiles are gateway-level platform attributes inherited by gateways as they are instantiated, connecting them to Nuage management infrastructure.
infrastructurevscprofiles
Infrastructure VSC Profiles identify a set of controllers which will be used to connect bootstrapped NSGs.
Infrastructure VSC Profiles identify a set of controllers which will be used to connect bootstrapped NSGs.
netconfprofiles
Represents configuration to access device using Netconf protocol
Represents configuration to access device using Netconf protocol
nsgpatchprofiles
An NSG Patch Profile contains upgrade information that can be given to an NSG Instance. The profile contains details on where the NSG can retrieve the image to upgrade to, and some criteria related to when the upgrade is to happen once the NSG device has received the information for upgrading.
An NSG Patch Profile contains upgrade information that can be given to an NSG Instance. The profile contains details on where the NSG can retrieve the image to upgrade to, and some criteria related to when the upgrade is to happen once the NSG device has received the information for upgrading.
nsgupgradeprofiles
An NSG Upgrade Profile contains upgrade information that can be given to an NSG Instance. The profile contains details on where the NSG can retrieve the image to upgrade to, and some criteria related to when the upgrade is to happen once the NSG device has received the information for upgrading.
An NSG Upgrade Profile contains upgrade information that can be given to an NSG Instance. The profile contains details on where the NSG can retrieve the image to upgrade to, and some criteria related to when the upgrade is to happen once the NSG device has received the information for upgrading.
ipsec
enterprisesecureddatas
This object represents the secured data object under the enterprise
This object represents the secured data object under the enterprise
enterprisesecurities
This object represents the enterprise security
This object represents the enterprise security
gatewaysecureddatas
This object represents the secured data object under the gateway
This object represents the secured data object under the gateway
gatewaysecurities
This object represents the gateway security object
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.
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
Represents a Group Key Profile
keyservermembers
Represents a KeyServer
Represents a KeyServer
keyservermonitorencryptedseeds
Represents a Keyserver Monitor Encrypted Seed Snapshot.
Represents a Keyserver Monitor Encrypted Seed Snapshot.
keyservermonitors
Represents a Keyserver Monitor Snapshot.
Represents a Keyserver Monitor Snapshot.
keyservermonitorseeds
Represents a Keyserver Monitor Seed Snapshot.
Represents a Keyserver Monitor Seed Snapshot.
keyservermonitorseks
Represents a Keyserver Monitor SEK Snapshot.
Represents a Keyserver Monitor SEK Snapshot.
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.
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
No description available
netconf
netconfmanagers
Identifies Netconf Manager communicating with VSD, This can only be created by netconfmgr user
Identifies Netconf Manager communicating with VSD, This can only be created by netconfmgr user
netconfdcgw
egressprofiles
An Egress Profile represents an aggregation of IP, MAC and egress QoS profiles that are applied on a VPort instance.
An Egress Profile represents an aggregation of IP, MAC and egress QoS profiles that are applied on a VPort instance.
ingressprofiles
An Ingress Profile represents an aggregation of IP, MAC and ingress QoS profiles that are applied on a VPort instance.
An Ingress Profile represents an aggregation of IP, MAC and ingress QoS profiles that are applied on a VPort instance.
ipfilterprofiles
7x50 IP Filter profile
7x50 IP Filter profile
ipv6filterprofiles
7x50 IPv6 Filter profile
7x50 IPv6 Filter profile
macfilterprofiles
7x50 MAC Filter profile
7x50 MAC Filter profile
sapegressqosprofiles
7x50 SAP Egress QoS profile
7x50 SAP Egress QoS profile
sapingressqosprofiles
7x50 SAP Ingress QoS profile
7x50 SAP Ingress QoS profile
network
addressranges
This is the definition of a Address Range associated with a Network.
This is the definition of a Address Range associated with a Network.
defaultgateways
This object represent default Gateway associated with Subnet
This object represent default Gateway associated with Subnet
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.
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.
This object is used to manipulate domain state. A domain corresponds to a distributed Virtual Router and Switch.
domaintemplates
A domain is a distributed logical router that enables L2 and L3 communication. A domain template is a model that can be instantiated as often as required, thereby creating real, functioning domains.
A domain is a distributed logical router that enables L2 and L3 communication. A domain template is a model that can be instantiated as often as required, thereby creating real, functioning domains.
enterprisenetworks
Network Macros are organization wide defined macros that can be used as a destination of a policy rule. For instance, you can create a network that represents your internal Intranet access, and use it as a destination of a policy rule to drop any packet that is coming from a particular port. Macros can now be created under SaaS Application Types. SaaS Application Types can then be associated to a SaaS Application Group which can be used as a destination of a policy rule.
Network Macros are organization wide defined macros that can be used as a destination of a policy rule. For instance, you can create a network that represents your internal Intranet access, and use it as a destination of a policy rule to drop any packet that is coming from a particular port. Macros can now be created under SaaS Application Types. SaaS Application Types can then be associated to a SaaS Application Group which can be used as a destination of a policy rule.
floatingips
Floating IP that is associated to a Domain. This floating IP could be used in the VM interface for NAT functionality.
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.
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.
This is the definition of a l2 domain associated with a Enterprise.
l2domaintemplates
An L2 Domain is a distributed logical switch that enables L2 communication. An L2 Domain template is a model that can be instantiated as often as required, thereby creating real, functioning L2 Domains.
An L2 Domain is a distributed logical switch that enables L2 communication. An L2 Domain template is a model that can be instantiated as often as required, thereby creating real, functioning L2 Domains.
multicastchannelmaps
Multicast channel maps define the available multicast groups that can be joined by VMs belonging to enterprises to which the maps have been assigned to. A map can contain one or more ranges defining the available channels. Ranges are non overlapping within a single map.
Multicast channel maps define the available multicast groups that can be joined by VMs belonging to enterprises to which the maps have been assigned to. A map can contain one or more ranges defining the available channels. Ranges are non overlapping within a single map.
multicastlists
This is the definition of a MultiCast Channel List.
This is the definition of a MultiCast Channel List.
multicastranges
A multicast channel map requires at least one range defined to be of use. Ranges within the same channel map must be non-overlapping between each other. Groups not covered by a range won't be joinable from the VMs.
A multicast channel map requires at least one range defined to be of use. Ranges within the same channel map must be non-overlapping between each other. Groups not covered by a range won't be joinable from the VMs.
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.
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
Network Macro Groups are a collection of existing Network Macros. These groups can be used in Security Policies in order to create rules that matches multiple Network Macros.
Network Macro Groups are a collection of existing Network Macros. These groups can be used in Security Policies in order to create rules that matches multiple Network Macros.
ospfareas
Represent an OSPF area
Represent an OSPF area
ospfinstances
Represent an OSPF instance. There can be only one OSPF instance per domain.
Represent an OSPF instance. There can be only one OSPF instance per domain.
ospfinterfaces
Represent an OSPF interface
Represent an OSPF interface
proxyarpfilters
Black list of ranges for which NSG will act as ARP Proxy
Black list of ranges for which NSG will act as ARP Proxy
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.
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
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.
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
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.
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.
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
No description available
uplinkroutedistinguishers
Represents a network port uplink route distinguisher value.
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.
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.
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.
As in domains and subnets, zones are derived from templates. This object provides the definition of the template.
nsg
captiveportalprofiles
Object representing a Wireless Access Captive Portal Profile which can be associated with SSID entities from which end users may be presented with instructions and condition of use when connecting to an open wireless access point.
Object representing a Wireless Access Captive Portal Profile which can be associated with SSID entities from which end users may be presented with instructions and condition of use when connecting to an open wireless access point.
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.
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
Network Services Gateways are a policy enforcement end-points responsible for the delivery of networking services. NSG access ports/VLANs may be attached to existing host or bridge VPorts.
Network Services Gateways are a policy enforcement end-points responsible for the delivery of networking services. NSG access ports/VLANs may be attached to existing host or bridge VPorts.
nsgatewaytemplates
Represents a Network Service Gateway Template.
Represents a Network Service Gateway Template.
nsginfos
Device information coming from the NSG
Device information coming from the NSG
nsgredundancygroups
Represents Redundant Group formed by two VNS Gateways.
Represents Redundant Group formed by two VNS Gateways.
nsports
Represents a Port of a particular NS Gateway object.
Represents a Port of a particular NS Gateway object.
nsporttemplates
Represents Port Template object under a given gateway template object.
Represents Port Template object under a given gateway template object.
shuntlinks
A shunt link represents an alliance of uplink interface resources between two NSGs belonging to a Redundant Group. An operator specifies which network port-VLAN from each NSG peers to be considered as shunted together so that control uplinks from each NSG may be used by the other.
A shunt link represents an alliance of uplink interface resources between two NSGs belonging to a Redundant Group. An operator specifies which network port-VLAN from each NSG peers to be considered as shunted together so that control uplinks from each NSG may be used by the other.
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.
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.
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.
zfbautoassignments
ZFB Enterprise Auto Assignment
ZFB Enterprise Auto Assignment
zfbrequests
A ZFB Request from an NSG
A ZFB Request from an NSG
operation
commands
A Command represents an operation that needs to be executed on an entity (NSG, Gateway, ...) which requires little processing by VSD, but may result in a long activity on the external entity. An example would be to trigger an action on VSD so that a Gateway download a new image. VSDs handling of the request is limited to generating a message to be sent to the device on which the download process is expected. The device then acts on the request and proceeds with the download... That may be a long process. The commands API is similar to the Jobs API with regards to triggering operations on objects.
A Command represents an operation that needs to be executed on an entity (NSG, Gateway, ...) which requires little processing by VSD, but may result in a long activity on the external entity. An example would be to trigger an action on VSD so that a Gateway download a new image. VSDs handling of the request is limited to generating a message to be sent to the device on which the download process is expected. The device then acts on the request and proceeds with the download... That may be a long process. The commands API is similar to the Jobs API with regards to triggering operations on objects.
perfrouting
applicationbindings
No description available
No description available
applicationperformancemanagementbindings
Association object for maintaining the priority of AppliationGroup(s) associated to a Domain
Association object for maintaining the priority of AppliationGroup(s) associated to a Domain
applicationperformancemanagements
Application Group is a container for group of applications
Application Group is a container for group of applications
applications
represents a application with L4/L7 classification
represents a application with L4/L7 classification
l7applicationsignatures
Layer 7 ApplicationType , these are auto created as part of VSD bringup
Layer 7 ApplicationType , these are auto created as part of VSD bringup
networkperformancebindings
No description available
No description available
performancemonitors
No description available
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.
Provides the definition of a single DSCP to a Forwarding class mapping that is part of a Table used in QoS policies.
dscpforwardingclasstables
DSCP Mapping Tables define a list of mappings from customer's DSCP markings to Forwarding Classes. They can be referenced in QoS policies.
DSCP Mapping Tables define a list of mappings from customer's DSCP markings to Forwarding Classes. They can be referenced in QoS policies.
egressdomainfloatingipaclentrytemplates
Defines the template of Egress Domain ACL Template entries
Defines the template of Egress Domain ACL Template entries
egressdomainfloatingipacltemplates
Defines the template for an Domain Floating IP ACL
Defines the template for an Domain Floating IP ACL
egressfloatingipaclentrytemplates
Defines the template of Egress ACL Template entries
Defines the template of Egress ACL Template entries
egressfloatingipacltemplates
Defines the template for an Floating IP ACL
Defines the template for an Floating IP ACL
forwardingpathlistentries
Forwarding path list entry to be associated with forwarding path list for l4 based policy to PAT / IKE to underlay.
Forwarding path list entry to be associated with forwarding path list for l4 based policy to PAT / IKE to underlay.
forwardingpathlists
Forwarding path list is l4 based policy to PAT / IKE to underlay.
Forwarding path list is l4 based policy to PAT / IKE to underlay.
l4servicegroups
Service Group is a set of Services that can be used in ACLs.
Service Group is a set of Services that can be used in ACLs.
l4services
Service is a port range and protocol combination that can be used in ACLs
Service is a port range and protocol combination that can be used in ACLs
policydecisions
This object is a read only object that provides the policy decisions for a particular VM interface.
This object is a read only object that provides the policy decisions for a particular VM interface.
saasapplicationtypes
SaaS applications like office365 with the published list of IPs and/or URLs for creating firewall rules for IT admins.
SaaS applications like office365 with the published list of IPs and/or URLs for creating firewall rules for IT admins.
policy/acl
egressaclentrytemplates
Defines the template of Egress ACL Template entries
Defines the template of Egress ACL Template entries
egressacltemplates
Defines the template for an Egress ACL.
Defines the template for an Egress ACL.
egressadvfwdentrytemplates
Egress forwarding policy rules define what action to take for a particular type of traffic, based on its origin, destination, protocol, EtherType, ports, DSCP value and other information. Supported actions are to redirect traffic, change the forwarding class of the traffic or to allow traffic to pass untouched.
Egress forwarding policy rules define what action to take for a particular type of traffic, based on its origin, destination, protocol, EtherType, ports, DSCP value and other information. Supported actions are to redirect traffic, change the forwarding class of the traffic or to allow traffic to pass untouched.
egressadvfwdtemplates
A group of egress forwarding policy rules. Each group can have priority which defines the order in which the egress forwarding policy rules are applied. The rules itself are used to redirect traffic or change the forwarding class of the traffic.
A group of egress forwarding policy rules. Each group can have priority which defines the order in which the egress forwarding policy rules are applied. The rules itself are used to redirect traffic or change the forwarding class of the traffic.
ingressaclentrytemplates
Defines the template of Ingress ACL entries
Defines the template of Ingress ACL entries
ingressacltemplates
Defines the template for an Ingress ACL.
Defines the template for an Ingress ACL.
ingressadvfwdentrytemplates
Defines the template of Ingress Advanced Forwarding entries
Defines the template of Ingress Advanced Forwarding entries
ingressadvfwdtemplates
Defines the template for an Ingress Advanced Forwarding.
Defines the template for an Ingress Advanced Forwarding.
ingressexternalserviceentrytemplates
Defines the template of Ingress External Service ACL entries
Defines the template of Ingress External Service ACL entries
ingressexternalservicetemplates
Defines the template for an Ingress External Service Acls.
Defines the template for an Ingress External Service Acls.
policy/dscpmapping
cosremarkingpolicies
Provides the definition of a single Forwarding class to CoS mapping that is part of a COS Remarking Policy Table used in QoS policies.
Provides the definition of a single Forwarding class to CoS mapping that is part of a COS Remarking Policy Table used in QoS policies.
cosremarkingpolicytables
Provides the definition of a table that holds multiple FC to Dot1p mappings . Used in Egress QoS policies.
Provides the definition of a table that holds multiple FC to Dot1p mappings . Used in Egress QoS policies.
dscpremarkingpolicies
Provides the definition of a single Forwarding class to DSCP mapping that is part of a DSCP Remarking table used in Egress QoS policies.
Provides the definition of a single Forwarding class to DSCP mapping that is part of a DSCP Remarking table used in Egress QoS policies.
dscpremarkingpolicytables
Provides the definition of a table that holds multiple Forwarding class to DSCP mappings. Used in Egress QoS policies.
Provides the definition of a table that holds multiple Forwarding class to DSCP mappings. Used in Egress QoS policies.
policy/qos
egressqospolicies
An Egress QoS Policy is a policy that groups rate-limiting profiles, traffic directionality and classifiers to govern the rate of traffic being sent or received by an end-host or application.
An Egress QoS Policy is a policy that groups rate-limiting profiles, traffic directionality and classifiers to govern the rate of traffic being sent or received by an end-host or application.
ingressqospolicies
A Tunnel Shaper QoS Policy is a policy that groups rate-limiting profiles, traffic directionality and classifiers to govern the rate of traffic being sent or received by an end-host or application.
A Tunnel Shaper QoS Policy is a policy that groups rate-limiting profiles, traffic directionality and classifiers to govern the rate of traffic being sent or received by an end-host or application.
qos
QoS policies enable you to classify and limit network traffic.
QoS policies enable you to classify and limit network traffic.
qospolicers
QoS Policer ensures that traffic adheres to the stipulated QoS defined in your network. Contains Rate and Burst configurations and can be associated to VLANs.
QoS Policer ensures that traffic adheres to the stipulated QoS defined in your network. Contains Rate and Burst configurations and can be associated to VLANs.
ratelimiters
Set of traffic management parameters describing a desired traffic profile. Rate-limiters are used by QoS policies to enforce per Class of Server rate-conformance.
Set of traffic management parameters describing a desired traffic profile. Rate-limiters are used by QoS policies to enforce per Class of Server rate-conformance.
policy/urlfiltering
destinationurls
destination URL under tier
destination URL under tier
tiers
When the customer creates an HTTP probe, VSD will automatically create Tier1 and Tier2 under it with default properties.
When the customer creates an HTTP probe, VSD will automatically create Tier1 and Tier2 under it with default properties.
stats
bulkstatistics
Retrieves the statistics for a particular Entity and its immediate child entity.
Retrieves the statistics for a particular Entity and its immediate child entity.
ltestatistics
Retrieves statistics for LTE uplink
Retrieves statistics for LTE uplink
statistics
Retrieves the statistics for a particular domain, zone, subnet, or VM.
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.
Identifies the IP address of the stats collector entity that must be used.
statisticspolicies
Defines the frequency of statistics collection associated with an object.
Defines the frequency of statistics collection associated with an object.
tcas
Provides the definition of the Threshold Control Alarms.
Provides the definition of the Threshold Control Alarms.
sysmon
bgppeers
Encapsulates the BGP peer information for system monitor entity.
Encapsulates the BGP peer information for system monitor entity.
components
System Monitoring details for components of VSD system.
System Monitoring details for components of VSD system.
hscs
System Monitoring details for hardware service controllers.
System Monitoring details for hardware service controllers.
monitoringports
Encapsulates the port information for system monitoring entity.
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.
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.
Encapsulates the Multi NIC VPort information for system monitoring entity.
vrss
System Monitoring details for VRS connected to VSC or HSC
System Monitoring details for VRS connected to VSC or HSC
vscs
System Monitoring details for VSC.
System Monitoring details for VSC.
vsds
System Monitoring details for VSD. This is deprecated and no longer provided through the Nuage API. This information can now be gathered through the Monit API.
System Monitoring details for VSD. This is deprecated and no longer provided through the Nuage API. This information can now be gathered through the Monit API.
vsps
System Monitoring details for VSP.
System Monitoring details for VSP.
systemconfig
systemconfigs
The system configuration which can be dynamically managed using rest api.
The system configuration which can be dynamically managed using rest api.
usermgmt
avatars
Avatar
Avatar
enterpriseprofiles
Enterprise profile, used to store an enterprise's policies, quota etc.
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.
Definition of the enterprise object. This is the top level object that represents an enterprise.
groups
Identifies a group within an enterprise
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.
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
Object that identifies the user functions
permissions
Represents Permitted action on an entity for a group.
Represents Permitted action on an entity for a group.
usercontexts
This defines a proxy class to expose some of the configuration parameters which are required by UI
This defines a proxy class to expose some of the configuration parameters which are required by UI
users
Object that identifies the user functions.
Object that identifies the user functions.
virtualfirewall
virtualfirewallpolicies
Defines the template for a Virtual Firewall Policy that helps to group a set of rules either based on functions or actions
Defines the template for a Virtual Firewall Policy that helps to group a set of rules either based on functions or actions
virtualfirewallrules
Defines the Virtual Firewall rules
Defines the Virtual Firewall rules
vm
diskstats
Encapsulates the disk usage metrics for system monitor entity.
Encapsulates the disk usage metrics for system monitor entity.
resync
Provide information about the state of a VM resync request.
Provide information about the state of a VM resync request.
vminterfaces
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.
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
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.
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
No description available
autodiscovereddatacenters
No description available
No description available
autodiscoveredhypervisors
No description available
No description available
eamconfigs
The EAM solution configuration.
The EAM solution configuration.
vcenterclusters
VCenter Clusters.
VCenter Clusters.
vcenterdatacenters
VCenter DataCenters.
VCenter DataCenters.
vcenterhypervisors
Host or Hypervisors.
Host or Hypervisors.
vcenters
Represents a VCenter.
Represents a VCenter.
vrsaddressranges
This is the definition of a Address Range associated with a VRS.
This is the definition of a Address Range associated with a VRS.
vrsconfigs
Default VRS Configuration parameters
Default VRS Configuration parameters
vrsmetrics
No description available
No description available
vrsredeploymentpolicies
No description available
No description available
vnf
vnfcatalogs
Represents VNF Catalog
Represents VNF Catalog
vnfdescriptors
The behavioral and deployment information of a VNF is defined in the VNF descriptor template. The template is based on the libvirt domain XML and is on-boarded in a VNF catalog. The resource requirements for CPU, memory and storage are defined in this screen and the rest of the template is inherited from the VNF Metadata object.
The behavioral and deployment information of a VNF is defined in the VNF descriptor template. The template is based on the libvirt domain XML and is on-boarded in a VNF catalog. The resource requirements for CPU, memory and storage are defined in this screen and the rest of the template is inherited from the VNF Metadata object.
vnfdomainmappings
This represents domain segment identifier which is unique for domain per NSGateway.
This represents domain segment identifier which is unique for domain per NSGateway.
vnfinterfacedescriptors
Represent VNF interface descriptor
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.
Represent VNF interface, This can not be created directly, it will be generated from VNF Interface Descriptor when VNF instance is created.
vnfmetadatas
The VNF deployment properties that includes the location of the image, bootstrap config and rest of the libvirt domain XML template defined as text file.
The VNF deployment properties that includes the location of the image, bootstrap config and rest of the libvirt domain XML template defined as text file.
vnfs
Instantiation of a VNF on a specified Network Services Gateway that has the resources to manage a VNF.
Instantiation of a VNF on a specified Network Services Gateway that has the resources to manage a VNF.
vnfthresholdpolicies
VNF Threshold Policy represents thresholds for resources consumed by VNF instance running on NS Gateway and action to be taken when resource utilization crosses configured thresholds.
VNF Threshold Policy represents thresholds for resources consumed by VNF instance running on NS Gateway and action to be taken when resource utilization crosses configured thresholds.
vport
brconnections
No description available
No description available
bridgeinterfaces
Provides information for each bridge interface.
Provides information for each bridge interface.
demarcationservices
test
test
hostinterfaces
Provides information for each host interface.
Provides information for each host interface.
mirrordestinations
Mirror Destinations are underlay-reachable IP addresses to which the mirrored traffic will be sent. On the server identified by the IP, a tool like Wireshark can be used to capture and analyse the traffic going through a VPort. The mirrored traffic is sent to the collector using GRE encapsulation.
Mirror Destinations are underlay-reachable IP addresses to which the mirrored traffic will be sent. On the server identified by the IP, a tool like Wireshark can be used to capture and analyse the traffic going through a VPort. The mirrored traffic is sent to the collector using GRE encapsulation.
overlaymirrordestinations
No description available
No description available
overlaymirrordestinationtemplates
No description available
No description available
pgexpressions
Policy Group Expression is an expression consisting of policy groups defined at Domain or L2 Domain Instance.
Policy Group Expression is an expression consisting of policy groups defined at Domain or L2 Domain Instance.
pgexpressiontemplates
Policy Group Expression Template is an expression consisting of policy groups defined at Domain Template or L2 Domain Template
Policy Group Expression Template is an expression consisting of policy groups defined at Domain Template or L2 Domain Template
policygroupcategories
Policy Group Categories are used to group Policy Group tags of similar type (e.g., Application, App-Tier, Location etc.) to provide additional context for flow visualization and analytics
Policy Group Categories are used to group Policy Group tags of similar type (e.g., Application, App-Tier, Location etc.) to provide additional context for flow visualization and analytics
policygroups
PolicyGroup is group of policys on which a user can policies like ACL, QoS, etc.
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.
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.
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.
Template for a vporttag. It can be created only at the template level and available for all instances.
virtualips
Virtual IP address.
Virtual IP address.
vportmirrors
VPort Mirror represents the relationship between a vport and a mirror destination.
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.
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.