{"type":"api","title":"Get multicast virtual networks","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getMulticastVirtualNetworks","tags":["SDA"],"summary":"Get multicast virtual networks","deprecated":false,"description":"Returns a list of multicast configurations for virtual networks that match the provided query parameters.","parameters":[{"name":"fabricId","description":"ID of the fabric site where multicast is configured.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"virtualNetworkName","description":"Name of the virtual network associated to the multicast configuration.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"offset","description":"Starting record for pagination.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"Maximum number of records to return. The maximum number of objects supported in a single request is 500.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Response body contains the result data.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the multicast configuration."},"fabricId":{"type":"string","description":"ID of the fabric site."},"virtualNetworkName":{"type":"string","description":"Name of the virtual network."},"ipPoolName":{"type":"string","description":"Name of the IP Pool."},"ipv4SsmRanges":{"type":"array","items":{"type":"string"},"description":"IPv4 Source Specific Multicast (SSM) ranges. Allowed ranges are from 225.0.0.0/8 to 239.0.0.0/8. SSM ranges should not conflict with ranges provided for ASM multicast."},"multicastRPs":{"type":"array","items":{"type":"object","properties":{"rpDeviceLocation":{"type":"string","enum":["EXTERNAL","FABRIC"],"description":"Device location of the RP."},"ipv4Address":{"type":"string","description":"IPv4 address of the RP. For external RP configuration, exactly one of ipv4Address or ipv6Address must be provided. For fabric RP, this address is allocated by SDA and should not be provided during RP creation request and SDA allocated address should be retained in subsequent requests."},"ipv6Address":{"type":"string","description":"IPv6 address of the RP. For external RP configuration, exactly one of ipv4Address or ipv6Address must be provided. For fabric RP, this address is allocated by SDA and should not be provided during RP creation request and SDA allocated address should be retained in subsequent requests. ipv6Address can only be provided for virtual networks with dual stack (IPv4 + IPv6) multicast pool."},"isDefaultV4RP":{"type":"boolean","description":"Specifies whether it is a default IPv4 RP."},"isDefaultV6RP":{"type":"boolean","description":"Specifies whether it is a default IPv6 RP."},"networkDeviceIds":{"type":"array","items":{"type":"string"},"description":"IDs of the network devices. This is a required field for fabric RPs. There can be maximum of two fabric RPs for a fabric site and these are shared across all multicast virtual networks. For configuring two fabric RPs in a fabric site both devices must have border roles. Only one RP can be configured in scenarios where a fabric edge device is used as RP or a dual stack multicast pool is used."},"ipv4AsmRanges":{"type":"array","items":{"type":"string"},"description":"IPv4 Any Source Multicast ranges. Comma seperated list of IPv4 multicast group ranges that will be served by a given Multicast RP. Only IPv4 ranges can be provided. For fabric RP, both IPv4 and IPv6 ranges can be provided together. For external RP, IPv4 ranges should be provided for IPv4 external RP and IPv6 ranges should be provided for IPv6 external RP."},"ipv6AsmRanges":{"type":"array","items":{"type":"string"},"description":"IPv6 Any Source Multicast ranges. Comma seperated list of IPv6 multicast group ranges that will be served by a given Multicast RP. Only IPv6 ranges can be provided. IPv6 ranges can only be provided for dual stack multicast pool. For fabric RP, both IPv4 and IPv6 ranges can be provided together. For external RP, IPv4 ranges should be provided for IPv4 external RP and IPv6 ranges should be provided for IPv6 external RP."}}},"description":"Multicast Rendezvous Points (RP). Required for Any Source Multicast (ASM) scenario."}}},"description":"Get response body."},"version":{"type":"string","description":"Version number."}},"description":"Multicast for virtual networks get response (Maximum number of records to return in each response is 500).","$$ref":"#/components/schemas/GetMulticastVirtualNetworksResponse"}}}},"400":{"description":"Bad Request. The client made a request that the server could not understand.","content":{}},"500":{"description":"Internal Server Error. The server could not fulfill the request.","content":{}}},"x-rapi-id":"048b-698b-4048-b3aa","x-rapi-overview":"Returns a list of multicast configurations for virtual networks that match the provided query parameters.","x-rapi-domain":"Connectivity","x-rapi-subdomain":"SDA","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/sda-helper-service/sda-open-api/multicast/virtualNetworks","x-rapi-publicPath":"/dna/intent/api/v1/sda/multicast/virtualNetworks","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getMulticastVirtualNetworks","method":"get","path":"/dna/intent/api/v1/sda/multicast/virtualNetworks"}}