Metadata

Metadata contains user-defined data that can be attached to any VSD object. The value of a metadata can be interpreted by various external systems for any needs. Local Metadata are directly created under an object.

Overview

assocEntityID string read only   filterable   orderable  
assocEntityType string read only   filterable   orderable  
blob string required   filterable   orderable  
description string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
global boolean filterable   orderable  
lastUpdatedBy string autogenerated  
metadataTagIDs list filterable  
name string filterable   orderable  
networkNotificationDisabled boolean filterable   orderable  

API Resource

/metadatas/id
delete get put

Parents

/containerinterfaces/id/metadatas
get post
get post
/qos/id/metadatas
get post
get post
/bgppeers/id/metadatas
get post
/sharednetworkresources/id/metadatas
get post
/ports/id/metadatas
get post
/policyentries/id/metadatas
get post
/pspatmaps/id/metadatas
get post
get post
/multicastlists/id/metadatas
get post
/multicastchannelmaps/id/metadatas
get post
/azureclouds/id/metadatas
get post
/enterprises/id/metadatas
get post
/redundancygroups/id/metadatas
get post
/vrsaddressranges/id/metadatas
get post
/vnfcatalogs/id/metadatas
get post
/sapegressqosprofiles/id/metadatas
get post
/ikesubnets/id/metadatas
get post
/macfilterprofiles/id/metadatas
get post
/vnfdescriptors/id/metadatas
get post
/vsgredundantports/id/metadatas
get post
/zones/id/metadatas
get post
/ikegatewayprofiles/id/metadatas
get post
get post
get post
/diskstats/id/metadatas
get post
/egressadvfwdtemplates/id/metadatas
get post
/vnfinterfaces/id/metadatas
get post
/locations/id/metadatas
get post
/enterprisesecurities/id/metadatas
get post
/eventlogs/id/metadatas
get post
/cms/id/metadatas
get post
/vrsconfigs/id/metadatas
get post
/ducgroups/id/metadatas
get post
/enterprisenetworks/id/metadatas
get post
get post
/permissions/id/metadatas
get post
/cosremarkingpolicies/id/metadatas
get post
/metadatas
get
/ipreservations/id/metadatas
get post
/overlayaddresspools/id/metadatas
get post
get post
/subnettemplates/id/metadatas
get post
/redirectiontargets/id/metadatas
get post
/virtualips/id/metadatas
get post
/testruns/id/metadatas
get post
/ikegatewayconnections/id/metadatas
get post
/vnfdomainmappings/id/metadatas
get post
/firewallacls/id/metadatas
get post
/gatewayredundantports/id/metadatas
get post
/egressaclentrytemplates/id/metadatas
get post
/vnfinterfacedescriptors/id/metadatas
get post
/patches/id/metadatas
get post
/multinicvports/id/metadatas
get post
/nsggroups/id/metadatas
get post
get post
/components/id/metadatas
get post
/avatars/id/metadatas
get post
get post
/bootstrapactivations/id/metadatas
get post
/licensestatus/id/metadatas
get post
/patnatpools/id/metadatas
get post
/ipv6filterprofiles/id/metadatas
get post
/vsps/id/metadatas
get post
/saasapplicationtypes/id/metadatas
get post
/mirrordestinations/id/metadatas
get post
/netconfsessions/id/metadatas
get post
/netconfprofiles/id/metadatas
get post
/nsredundantports/id/metadatas
get post
/vnfthresholdpolicies/id/metadatas
get post
/ssidconnections/id/metadatas
get post
/overlaypatnatentries/id/metadatas
get post
/vscs/id/metadatas
get post
/deploymentfailures/id/metadatas
get post
/controllervrslinks/id/metadatas
get post
/vports/id/metadatas
get post
/tiers/id/metadatas
get post
/vpnconnections/id/metadatas
get post
/policystatements/id/metadatas
get post
/statisticspolicies/id/metadatas
get post
/policygroupcategories/id/metadatas
get post
/subnets/id/metadatas
get post
/testsuiteruns/id/metadatas
get post
/policygroups/id/metadatas
get post
/ratelimiters/id/metadatas
get post
get post
/gatewaytemplates/id/metadatas
get post
/allgateways/id/metadatas
get post
/ltestatistics/id/metadatas
get post
/zonetemplates/id/metadatas
get post
/tcas/id/metadatas
get post
/keyservermonitorseeds/id/metadatas
get post
/trunks/id/metadatas
get post
/lteinformations/id/metadatas
get post
/vrss/id/metadatas
get post
/hscs/id/metadatas
get post
get post
/ldapconfigurations/id/metadatas
get post
/ingressadvfwdtemplates/id/metadatas
get post
/zfbrequests/id/metadatas
get post
/enterprisepermissions/id/metadatas
get post
/netconfgateways/id/metadatas
get post
/staticroutes/id/metadatas
get post
/testdefinitions/id/metadatas
get post
/jobs/id/metadatas
get post
/vminterfaces/id/metadatas
get post
/gatewaysecureddatas/id/metadatas
get post
/vcenterhypervisors/id/metadatas
get post
/groups/id/metadatas
get post
/sapingressqosprofiles/id/metadatas
get post
/keyservermonitors/id/metadatas
get post
/networklayout/id/metadatas
get post
/testsuites/id/metadatas
get post
/ducgroupbindings/id/metadatas
get post
/certificates/id/metadatas
get post
/licenses/id/metadatas
get post
/connectionendpoints/id/metadatas
get post
/enterpriseprofiles/id/metadatas
get post
/bridgeinterfaces/id/metadatas
get post
/infraconfig/id/metadatas
get post
/dscpremarkingpolicies/id/metadatas
get post
/egressprofiles/id/metadatas
get post
/networkmacrogroups/id/metadatas
get post
/forwardingpathlists/id/metadatas
get post
get post
/applicationbindings/id/metadatas
get post
/destinationurls/id/metadatas
get post
/autodiscoveredgateways/id/metadatas
get post
get post
/nexthops/id/metadatas
get post
/domains/id/metadatas
get post
/domainkindsummaries/id/metadatas
get post
/brconnections/id/metadatas
get post
/dhcpv6options/id/metadatas
get post
get post
/ospfinterfaces/id/metadatas
get post
/addressmaps/id/metadatas
get post
/underlays/id/metadatas
get post
/gateways/id/metadatas
get post
/egressqospolicies/id/metadatas
get post
/webcategories/id/metadatas
get post
/bfdsessions/id/metadatas
get post
/statistics/id/metadatas
get post
/nsporttemplates/id/metadatas
get post
/sshkeys/id/metadatas
get post
/services/id/metadatas
get post
/vcenterdatacenters/id/metadatas
get post
/customproperties/id/metadatas
get post
/policyobjectgroups/id/metadatas
get post
/virtualfirewallrules/id/metadatas
get post
/virtualfirewallpolicies/id/metadatas
get post
get post
/ptranslationmaps/id/metadatas
get post
/webdomainnames/id/metadatas
get post
/ikegateways/id/metadatas
get post
/csnatpools/id/metadatas
get post
/shuntlinks/id/metadatas
get post
/vcenters/id/metadatas
get post
/bulkstatistics/id/metadatas
get post
/ingressaclentrytemplates/id/metadatas
get post
/routingpolicies/id/metadatas
get post
get post
get post
/defaultgateways/id/metadatas
get post
/saasapplicationgroups/id/metadatas
get post
/systemconfigs/id/metadatas
get post
/l2domains/id/metadatas
get post
/ikegatewayconfig/id/metadatas
get post
/vrsinfos/id/metadatas
get post
/hostinterfaces/id/metadatas
get post
/enterprisesecureddatas/id/metadatas
get post
get post
/qospolicers/id/metadatas
get post
/links/id/metadatas
get post
/statisticscollector/id/metadatas
get post
/porttemplates/id/metadatas
get post
/usercontexts/id/metadatas
get post
/gatewayslocations/id/metadatas
get post
/l7applicationsignatures/id/metadatas
get post
/ospfinstances/id/metadatas
get post
/dhcpoptions/id/metadatas
get post
/keyservermembers/id/metadatas
get post
/nsgateways/id/metadatas
get post
/nsgatewaytemplates/id/metadatas
get post
get post
/vms/id/metadatas
get post
/vsds/id/metadatas
get post
/netconfmanagers/id/metadatas
get post
/nsgroutingpolicybindings/id/metadatas
get post
/nsgatewayscounts/id/metadatas
get post
/aggregateddomains/id/metadatas
get post
/bgpprofiles/id/metadatas
get post
/ctranslationmaps/id/metadatas
get post
/publicnetworks/id/metadatas
get post
/l2domaintemplates/id/metadatas
get post
/ingressqospolicies/id/metadatas
get post
/addressranges/id/metadatas
get post
/domaintemplates/id/metadatas
get post
/sites/id/metadatas
get post
/nsgatewayssummaries/id/metadatas
get post
/resync/id/metadatas
get post
/gatewaysecurities/id/metadatas
get post
/policydecisions/id/metadatas
get post
/spatsourcespools/id/metadatas
get post
/alarms/id/metadatas
get post
/floatingips/id/metadatas
get post
/egressacltemplates/id/metadatas
get post
/monitoringports/id/metadatas
get post
/monitorscopes/id/metadatas
get post
/ipfilterprofiles/id/metadatas
get post
/multicastranges/id/metadatas
get post
/nsgredundancygroups/id/metadatas
get post
/applications/id/metadatas
get post
/keyservermonitorseks/id/metadatas
get post
/cosremarkingpolicytables/id/metadatas
get post
/vportmirrors/id/metadatas
get post
/mirrordestinationgroups/id/metadatas
get post
/tests/id/metadatas
get post
/psnatpools/id/metadatas
get post
/bgpneighbors/id/metadatas
get post
/containerresync/id/metadatas
get post
/vnfs/id/metadatas
get post
/allredundancygroups/id/metadatas
get post
/allalarms/id/metadatas
get post
/vlans/id/metadatas
get post
/wirelessports/id/metadatas
get post
/eamconfigs/id/metadatas
get post
/ikeencryptionprofiles/id/metadatas
get post
/policygrouptemplates/id/metadatas
get post
/vcenterclusters/id/metadatas
get post
/users/id/metadatas
get post
/natmapentries/id/metadatas
get post
/containers/id/metadatas
get post
/demarcationservices/id/metadatas
get post
/firewallrules/id/metadatas
get post
/nsports/id/metadatas
get post
/bootstraps/id/metadatas
get post
/vlantemplates/id/metadatas
get post
/uplinkconnections/id/metadatas
get post
/globalmetadatas/id/metadatas
get post
get post
/ospfareas/id/metadatas
get post
/ikepsks/id/metadatas
get post
/ikecertificates/id/metadatas
get post
/ingressacltemplates/id/metadatas
get post
/vnfmetadatas/id/metadatas
get post
/ingressprofiles/id/metadatas
get post
/remotevrsinfos/id/metadatas
get post

Children

/metadatas/id/eventlogs
get

Members

This object has no members.

Attributes documentation

assocEntityID string read only   filterable   orderable  
Discussion

ID of the entity to which the Metadata is associated to.


Charateristics

Format: free
SDK attribute: assocEntityID

assocEntityType string read only   filterable   orderable  
Discussion

Type of the entity to which the Metadata is associated to.


Charateristics

Format: free
SDK attribute: assocEntityType

blob string required   filterable   orderable  
Discussion

Metadata that describes about the entity attached to it.


Charateristics

Format: free
Min length: 1
Max length: 104857600
SDK attribute: blob

description string filterable   orderable  
Discussion

Description of the Metadata.


Charateristics

Format: free
Max length: 255
SDK attribute: description

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

global boolean filterable   orderable  
Discussion

specifies metadata is global or local


Charateristics

SDK attribute: globalMetadata

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

metadataTagIDs list filterable  
Discussion

metadata tag IDs associated with this metadata you can filter metadata based on this attribute for example X-Nuage-Filter: '2d6fb627-603b-421c-b63a-eb0a6d712761' IN metadataTagIDs


Charateristics

SDK attribute: metadataTagIDs

name string filterable   orderable  
Discussion

name of the Metadata.


Charateristics

Format: free
Max length: 255
SDK attribute: name

networkNotificationDisabled boolean filterable   orderable  
Discussion

specifies metadata changes need to be notified to controller,by default it is notified


Charateristics

SDK attribute: networkNotificationDisabled