Multicast Routing
Overview
A multicast routing is a networking method for efficient distribution
of one-to-many traffics. In ZStack Cloud, VPC vRouters receive
multicast information sent by multicast sources and forward the information to VM
instances to realize one-to-many connections on senders and receivers.
- ZStack Cloud allows you to use VM instances as the multicast information receivers, and to use VPC vRouters as multicast routers to participate in the multicast routing message exchanges.
- VPC vRouters support the PIM-SM/PIM-SSM protocol. In the PIM-SM protocol, RP routers are the key devices in the PIM-SM domain. You can either manually configure RP addresses or dynamically elect or assign RP addresses according to the BSR mechanism.
The multicast routing topology is shown in Multicast Routing
Topology.Figure 1. Multicast Routing Topology
Inventory
Multicast Router Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.7.0 | ||
| state | 3.7.0 | |||
| description | The description. For more information, see Resource Property. | Yes | 3.7.0 | |
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.7.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.7.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.7.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 |
Sample
{
"inventories": [],
"success": true
}
Operations
CreateMulticastRouter
Creates a multicast router. For
example,
CreateMulticastRouter vpcRouterVmUuid=974c38ae483737c3b4ded18de56773b6Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vpcRouterVmUuid | 3.7.0 | |||
| description | The detailed description of the resource. | Yes | 3.7.0 | |
| resourceUuid | Yes | 3.7.0 | ||
| tagUuids | The tag UUID list. | Yes | 3.7.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
DeleteMulticastRouter
Deletes a multicast router. For
example,
DeleteMulticastRouter uuid=cce17d3b823933a8b0694af5159fed4dParameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.7.0 | ||
| deleteMode | Yes | 3.7.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
QueryMulticastRouter
Queries a multicast router. For example,
QueryMulticastRouter Primitive Fields of Query
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| rpGroups | RP Group Inventory | The RP group of the multicast router. | 3.7.0 |
| vpcVrs | VPC vRouters Inventory | The VPC vRouter associated with the multicast router. | 3.7.0 |
ChangeMulticastRouterState
Changes the state of a multicast router. For
example,
ChangeMulticastRouterState uuid=0cbf995f538b3aed855e3e50ea38eb0c stateEvent=enableParameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.7.0 | ||
| stateEvent |
|
3.7.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
GetVpcMulticastRoute
Obtains a list of multicast routes. For
example,
GetVpcMulticastRoute uuid=a880287e652d3137a9f7349dc7f65a49Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.7.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
AddRendezvousPointToMulticastRouter
Adds a static rendezvous point (RP) address to a multicast router. For
example,
AddRendezvousPointToMulticastRouter uuid=9127988e024a3a87865efcd1381d8fd4 rpAddress=1.2.3.4 groupAddress=239.0.0.1/32Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.7.0 | ||
| rpAddress | 3.7.0 | |||
| groupAddress | 3.7.0 | |||
| resourceUuid | Yes | 3.7.0 | ||
| tagUuids | The tag UUID list. | Yes | 3.7.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
RemoveRendezvousPointFromMulticastRouter
Removes a static rendezvous point (RP) address from a multicast router. For
example,
RemoveRendezvousPointFromMulticastRouter uuid=b0efeaec578931d49c6c8b457287e1db rpAddress=1.2.3.4 groupAddress=239.1.1.1/32Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.7.0 | ||
| rpAddress | 3.7.0 | |||
| groupAddress | 3.7.0 | |||
| deleteMode | Yes | 3.7.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
Tags
Multicast Router Tags
You can create a user tag on a multicast router by using
resourceType=MulticastRouterVO. For
example,
CreateUserTag resourceType=MulticastRouterVO tag=MulticastRouter-user \
resourceUuid=3533e0dcd01d4e2aa8697048e152c5d8