(Supporting Network Advisor 12.3.0)

52 Brocade Network Advisor REST API Guide
53-1003160-01
Topology
5
ResourceGroups
Network Advisor supports “network scopes.” A network scope is a grouping of resources, a sort of
a convenience mechanism to enable you to retrieve data for any grouping of your choice. In the
Network Advisor REST API, a “resource group” is the equivalent of a “network scope.”
Resource groups can be predefined system groups or they can be user-defined groups. They are
keyed by unique names. Each resource group, whether system-defined or user-defined, is of a
particular type as defined by the enumeration
NetworkScopeType. The resource group type
enables you to differentiate user-defined groups from other groups.
The system-defined resource group named “All” encompasses all resources. The resource group is
the starting point for all of the supported URIs in the Network Advisor REST API.
GET URIs
Path parameters
Response parameters
Notes
The response schema is ResourceGroupsResponse.
URI Description
<BASE_URI>/resourcegroups Returns all the resource groups in the system.
<BASE_URI>/resourcegroups/rgkey Returns the specified resource group.
Name Description
rgkey Resource group identifier.
Property Description
key The unique identifier for the resource group. The key is the unique resource group
name with spaces encoded.
name The unique name of the resource group.
type The type of resource group.