Skip to content

Get-OVScope

Syntax

Get-OVScope
    [-Name <String>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

Description

A scope is a grouping of resources that can be used to restrict the range of an operation or action. For example, you can create scopes based on:

  • Organizations (Marketing, Research and Development, Finance)
  • Usage (Production, Development, Testing)
  • Skills (Linux, Windows)

The resources are arranged by categories. All the resources in these categories can be added to or removed from a scope:

  • Enclosures
  • Server Hardware
  • Networks (Ethernet, FC, and FCoE)
  • Network Sets
  • Interconnects, excluding SAS resources
  • Logical Interconnects, excluding SAS resources
  • Logical Interconnect Groups, excluding SAS resources
  • OS Deployment Plans
  • Switches
  • Logical Switches
  • Logical Switch Groups
  • Rack Managers
  • Storage Pools
  • Volumes
  • Volume Templates
  • Volume Sets
Info

Resources in other categories are considered to be included in all scopes, and they cannot be removed.

Warning

For email notification of alerts, resources that are not categorized here are included in any scope. An email notification filter that specifies one or more scopes does not eliminate alerts generated by resources that are not currently categorized here. Inhibiting alerts from non-scope resources requires the use of associated resource categories, which is described in "Edit an email recipient and filter entry" online help chapter.

When scopes are defined and resources assigned to them, you can:

  • Restrict the resources displayed in the user interface (UI) to those assigned to the scope.
  • Restrict user permissions to grant access only to the resources in a scope.
  • Configure filtered email notifications for alerts based on previously-defined scopes.

Returned Scope object(s) will contain a collection of associated resources.

Minimum Minimum required privileges: Read-Only

Examples

Example 1

Get-OVScope

List all available scopes on the connected default appliance.

Example 2

Get-OVScope -Name MyFinanceScope

Return the "MyFinanceScope" scope resource from the conncted default appliance.

Example 3

Get-OVScope -Name My* -ApplianceConnection $ConnectedSessions

Use wildcard search for a specific scope on all connected appliances.

Parameters

-Name <String>

Name of the scope to return.

Aliases None
Required? False
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? False

-ApplianceConnection <Object>

Specify one or more [HPEOneView.Appliance.Connection] object(s) or Name property value(s).

Aliases Appliance
Required? False
Position? Named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters? False

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None. You cannot pipe objects to this Cmdlet.

Return Values

Collection of Appliance Scope resource objects.