Query User Scope

The following example shows the request and response that is defined in the XSD files for the QueryScope tag. If the Name element occurs, the CMP queries only the corresponding scope, otherwise all scopes are queried.

Request

This request follows the QueryScope tag defined in the XSD files.

<XmlInterfaceRequest>
    <QueryScope>
      <Name>Global</Name>
    </QueryScope>
</XmlInterfaceRequest>

If query is successful, the list of the scopes are returned in XML as a response. If no Ref element occurs, it means the scope is a global scope in system.

The QueryScope operation parameters are as follows:
  • Name (Optional)

    250 characters (string); can only contain the characters A–Z, a–z, 0–9, period (.), hyphen (-), and underline (_)

If the query is successful, the list of the roles will be returned in XML as a response.

The output fields for the QueryScope operation are as follows:
  • Name

    The name of the scope.

  • Description

    The description of the scope.

  • ResourceControllerGroupRef

    The name set for the manageable MPE server.

  • MRAGroupRef:

    The name set for the manageable MRA server.

  • NetworkElementGroupRef:

    The name set for the manageable Network Elements.

Response

The response to this request:

<ConfigurationData version="7.5.0">
    <Scope>
        <Name>Global</Name>
        <Description>The default scope that automatically contains all items in the system</Description>
    </Scope>
</ConfigurationData>

A subset of the Ref element is in the XML file based on the mode selected. The output XML cannot be imported to the CMP again.