Metadata

Metadata associated to a entity.

Overview

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

API Resource

/metadatas/id
delete get put

Parents

/containerinterfaces/id/metadatas
get post
/groupkeyencryptionprofiles/id/metadatas
get post
/qos/id/metadatas
get post
/ingressadvfwdentrytemplates/id/metadatas
get post
/bgppeers/id/metadatas
get post
/sharednetworkresources/id/metadatas
get post
/virtualips/id/metadatas
get post
/multicastlists/id/metadatas
get post
/multicastchannelmaps/id/metadatas
get post
/enterprises/id/metadatas
get post
/redundancygroups/id/metadatas
get post
/tcas/id/metadatas
get post
/groups/id/metadatas
get post
/vsgredundantports/id/metadatas
get post
/zones/id/metadatas
get post
/externalservices/id/metadatas
get post
/ikegatewayprofiles/id/metadatas
get post
/ikesubnets/id/metadatas
get post
/infrastructuregatewayprofiles/id/metadatas
get post
/policygrouptemplates/id/metadatas
get post
/flowsecuritypolicies/id/metadatas
get post
/eamconfigs/id/metadatas
get post
/locations/id/metadatas
get post
/enterprisesecurities/id/metadatas
get post
/vrsconfigs/id/metadatas
get post
/enterprisenetworks/id/metadatas
get post
/infrastructurevscprofiles/id/metadatas
get post
/permissions/id/metadatas
get post
/ipreservations/id/metadatas
get post
/redirectiontargettemplates/id/metadatas
get post
/subnettemplates/id/metadatas
get post
/metadatatags/id/metadatas
get put
/egressfloatingipacltemplates/id/metadatas
get post
/ikegatewayconnections/id/metadatas
get post
/redirectiontargets/id/metadatas
get post
/egressaclentrytemplates/id/metadatas
get post
/ingressexternalserviceentrytemplates/id/metadatas
get post
/dscpforwardingclasstables/id/metadatas
get post
/components/id/metadatas
get post
/avatars/id/metadatas
get post
/bootstrapactivations/id/metadatas
get post
/gatewaytemplates/id/metadatas
get post
/patnatpools/id/metadatas
get post
/vsps/id/metadatas
get post
/mirrordestinations/id/metadatas
get post
/nsredundantports/id/metadatas
get post
/dscpforwardingclassmappings/id/metadatas
get post
/porttemplates/id/metadatas
get post
/services/id/metadatas
get post
/vsds/id/metadatas
get post
/vports/id/metadatas
get post
/flowforwardingpolicies/id/metadatas
get post
/vpnconnections/id/metadatas
get post
/statisticspolicies/id/metadatas
get post
/subnets/id/metadatas
get post
/policygroups/id/metadatas
get post
/ratelimiters/id/metadatas
get post
/keyservermonitorencryptedseeds/id/metadatas
get post
/zonetemplates/id/metadatas
get post
/keyservermonitorseeds/id/metadatas
get post
/vrss/id/metadatas
get post
/hscs/id/metadatas
get post
/ldapconfigurations/id/metadatas
get post
/ingressadvfwdtemplates/id/metadatas
get post
/zfbrequests/id/metadatas
get post
/enterprisepermissions/id/metadatas
get post
/staticroutes/id/metadatas
get post
/jobs/id/metadatas
get post
/vminterfaces/id/metadatas
get post
/gatewaysecureddatas/id/metadatas
get post
/vcenterhypervisors/id/metadatas
get post
/keyservermonitors/id/metadatas
get post
/networklayout/id/metadatas
get post
/certificates/id/metadatas
get post
/licenses/id/metadatas
get post
/enterpriseprofiles/id/metadatas
get post
/bridgeinterfaces/id/metadatas
get post
/infraconfig/id/metadatas
get post
/multicastranges/id/metadatas
get post
/networkmacrogroups/id/metadatas
get post
/infrastructureaccessprofiles/id/metadatas
get post
/autodiscoveredgateways/id/metadatas
get post
/nexthops/id/metadatas
get post
/keyservernotifications/id/metadatas
get post
/domains/id/metadatas
get post
/tiers/id/metadatas
get post
/egressdomainfloatingipacltemplates/id/metadatas
get post
/addressmaps/id/metadatas
get post
/gateways/id/metadatas
get post
/multinicvports/id/metadatas
get post
/bfdsessions/id/metadatas
get post
/statistics/id/metadatas
get post
/nsporttemplates/id/metadatas
get post
/eventlogs/id/metadatas
get post
/vcenterdatacenters/id/metadatas
get post
/ltestatistics/id/metadatas
get post
/egressdomainfloatingipaclentrytemplates/id/metadatas
get post
/applicationservices/id/metadatas
get post
/ikegateways/id/metadatas
get post
/statisticscollector/id/metadatas
get post
/vcenters/id/metadatas
get post
/bulkstatistics/id/metadatas
get post
/ingressaclentrytemplates/id/metadatas
get post
/routingpolicies/id/metadatas
get post
/l2domains/id/metadatas
get post
/ikegatewayconfig/id/metadatas
get post
/hostinterfaces/id/metadatas
get post
/enterprisesecureddatas/id/metadatas
get post
/links/id/metadatas
get post
/ingressexternalservicetemplates/id/metadatas
get post
/me/id/metadatas
get post
/endpoints/id/metadatas
get post
/dhcpoptions/id/metadatas
get post
/keyservermembers/id/metadatas
get post
/nsgateways/id/metadatas
get post
/nsgatewaytemplates/id/metadatas
get post
/vscs/id/metadatas
get post
/uplinkroutedistinguishers/id/metadatas
get post
/vms/id/metadatas
get post
/alarms/id/metadatas
get post
/vrsaddressranges/id/metadatas
get post
/bgpprofiles/id/metadatas
get post
/egressqospolicies/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
/cms/id/metadatas
get post
/resync/id/metadatas
get post
/policydecisions/id/metadatas
get post
/floatingips/id/metadatas
get post
/egressacltemplates/id/metadatas
get post
/monitoringports/id/metadatas
get post
/ports/id/metadatas
get post
/nsgredundancygroups/id/metadatas
get post
/keyservermonitorseks/id/metadatas
get post
/vportmirrors/id/metadatas
get post
/bgpneighbors/id/metadatas
get post
/containerresync/id/metadatas
get post
/allalarms/id/metadatas
get post
/vlans/id/metadatas
get post
/systemconfigs/id/metadatas
get post
/ikeencryptionprofiles/id/metadatas
get post
/egressfloatingipaclentrytemplates/id/metadatas
get post
/vcenterclusters/id/metadatas
get post
/users/id/metadatas
get post
/natmapentries/id/metadatas
get post
/containers/id/metadatas
get post
/externalappservices/id/metadatas
get post
/nsports/id/metadatas
get post
/bootstraps/id/metadatas
get post
/flows/id/metadatas
get post
/vlantemplates/id/metadatas
get post
/gatewaysecurities/id/metadatas
get post
/globalmetadatas/id/metadatas
get post
/ikepsks/id/metadatas
get post
/ikecertificates/id/metadatas
get post
/ingressacltemplates/id/metadatas
get post

Children

/metadatas/id/eventlogs
get

Members

/metadatas/id/metadatatags
get put

Attributes documentation

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   filterable   orderable  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
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

Format: free
SDK attribute: globalMetadata

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

Format: free
SDK attribute: networkNotificationDisabled