MultiCastChannelMap

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.

Overview

description string filterable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  

API Resource

/multicastchannelmaps/id
delete get put

Parents

/containerinterfaces/id/multicastchannelmaps
get
/multicastlists/id/multicastchannelmaps
get put
/multicastchannelmaps
get post
/vminterfaces/id/multicastchannelmaps
get
/hostinterfaces/id/multicastchannelmaps
get

Children

/multicastchannelmaps/id/permissions
delete get post put
/multicastchannelmaps/id/metadatas
get post
/multicastchannelmaps/id/globalmetadatas
get post put
/multicastchannelmaps/id/multicastranges
get post
/multicastchannelmaps/id/eventlogs
get

Members

This object has no members.

Attributes documentation

description string filterable  
Discussion

A description field provided by the user that identifies the MultiCast Channel Map


Charateristics

Format: free
Max length: 255
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.


Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

Name of the current entity


Charateristics

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