Cisco UCS Manager Management Pack User Guide, Release 4.x For Microsoft System Center Operations Manager

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents
Find Matches in This Book

Results

Updated:
March 21, 2021

Chapter: PowerShell Cmdlets for Cisco UCS Management Pack

PowerShell Cmdlets for Cisco UCS Management Pack

This chapter contains the following sections:

Importing Cmdlets from the PowerShell Module

Procedure

Step 1

On a Management Server open Operations Manager Shell.

The Cisco PowerShell module is shared across all the Management Servers in the Management Group.

Note 

The CiscoUcsScomPs module is installed in %PROGRAMDATA%\Cisco\Modules.

Step 2

Import the CiscoUcsScomPs module.
Step 3

To see all cmdlets in CiscoUcsScomPs module, use the Get-Command -Module CiscoUcsScomPs command in the PowerShell window.

Note 

If you are using another PowerShell session, import the OperationsManager module before importing the CiscoUcsScomPs module.

Adding or Updating UCS Instances

Add-UcsScomInstance

Provide either an existing management pack or name for new management pack to add this instance. If none is provided, a new management pack is created with the same name as that of instance. 


Add-UcsScomInstance -UcsIPAddress <string> -MachineType <string> 
{Agent Managed Computer (Trusted Boundary) |
Agent Managed Computer (Untrusted Boundary) | Management Server | 
Gateway Server} -MachineName <string>
-InstanceName <string> [-Port <int>] [-ManagementPackName <string>] 
[-Description <string>] [-NoSsl] [-ProxyHos
<string>] [-ProxyPort <int>] [-ProxyUsername <string>] 
[-ProxyPassword <string>] [-ExistingRunAsAccount <string
[-OrgDiscoveryLevel <int>] [-ShowUnassociatedProfiles] 
[-SuspendPerformanceStatsCollection]  [<CommonParameters

Add-UcsScomInstance -UcsIPAddress <string> -MachineType <string> 
{Agent Managed Computer (Trusted Boundary) |
Agent Managed Computer (Untrusted Boundary) | Management Server | 
Gateway Server} -MachineName <string>
-InstanceName <string> -RunAsAccount <string> -RunAsCredential 
<pscredential> [-Port <int>] [-ManagementPackNam
string>] [-Description <string>] [-NoSsl] [-ProxyHost <string>] 
[-ProxyPort <int>] [-ProxyUsername <string>]
[-ProxyPassword <string>] [-OrgDiscoveryLevel <int>] 
[-ShowUnassociatedProfiles]
[-SuspendPerformanceStatsCollection]  [<CommonParameters>]



Add-UcsScomInstance -UcsIPAddress <string> -MachineType 
<string> {Agent Managed Computer (Trusted Boundary) |
Agent Managed Computer (Untrusted Boundary) | 
Management Server | Gateway Server} -MachineName <string>
-InstanceName <string> -ExistingManagementPack <ManagementPack> 
-Description <string> -RunAsAccount <string>
-RunAsCredential <pscredential> [-Port <int>] [-NoSsl] 
[-ProxyHost <string>] [-ProxyPort <int>] [-ProxyUsername
<string>] [-ProxyPassword <string>] 
[-OrgDiscoveryLevel <int>] [-ShowUnassociatedProfiles]
[-SuspendPerformanceStatsCollection]  [<CommonParameters>]

 

 Add-UcsScomInstance -UcsIPAddress <string> 
-MachineType <string> {Agent Managed Computer (Trusted Boundary) |
Agent Managed Computer (Untrusted Boundary) | 
Management Server | Gateway Server} -MachineName <string>
-InstanceName <string> -ExistingManagementPack 
<ManagementPack> -Description <string> [-Port <int>] [-NoSsl]
[-ProxyHost <string>] [-ProxyPort <int>] 
[-ProxyUsername <string>] [-ProxyPassword <string>]
[-ExistingRunAsAccount <string>] [-OrgDiscoveryLevel <int>] 
[-ShowUnassociatedProfiles]
[-SuspendPerformanceStatsCollection]  [<CommonParameters>]

Parameter

Description

UcsIPAddress

IP address or host name of the UCS to register

MachineType

Type of Operations Manager machine to register the UCS

MachineName

FQDN of the machine on which UCS is registered (all scripts related to this UCS MP will be run on this machine)

InstanceName

Name to be given to this UCS instance

Port

Port number

ManagementPackName

Name of the new management pack to be created (if not specified, InstacneName will be used for management pack)

Description

Optional description string for the UCS instance

NoSsl

Switch parameter to specify non-secure (http) connectivity with UCS

ProxyHost

IP address or hostname of proxy server to be used for communicating with UCS

ProxyPort

Proxy port number

ProxyUsername

Username for proxy server

ProxyPassword

Password for proxy server

ExistingRunAsAccount

Name of the existing Run-As account to be used for this instance

RunAsAccount

Name of new Run-As account to be created for this instance

RunAsCredential

UCS credentials for the new Run-As account to be created

ExistingManagementPack

Existing management pack object to which the instance is to be added

Note

You can either add an UCS instance on a new Management Pack or on an existing pack name, but you cannot do both for a single instance.

Example


$secureString = ConvertTo-SecureString "PASSWORD" -AsPlainText -Force
$credentials = New-Object System.Management.Automation.PSCredential 
("USERNAME",$secureString)
 
Add-UcsScomInstance -UcsIPAddress 10.10.10.10 –InstanceName 
‘UCSNAME_10’ –MachineType ‘Management Server’ –MachineName 
FQDN of ‘SCOM_MS1’ –Secure –ProxyHost ’10.10.10.2’ 
–ProxyPort 58 –RunAsAccount ‘UCS10’ –RunAsCredential $credentials

Update-UcsScomInstance


Update-UcsScomInstance [-InstanceName] <string> 
[[-UcsIPAddress] <string>] [[-Port] <string>] [[-MachineType]
<string> {Agent Managed Computer (Trusted Boundary) | 
Agent Managed Computer (Untrusted Boundary) | Management
Server | Gateway Server}] [[-MachineName] <string>] 
[[-Description] <string>] [[-Secure] <bool>] [[-ProxyHost]
<string>] [[-ProxyPort] <int>] [[-ProxyUsername] <string>] 
[[-ProxyPassword] <string>] [[-OrgDiscoveryLevel]
<int>] [[-ShowUnassociatedProfiles] <bool>] 
[[-SuspendPerformanceStatsCollection] <bool>]  [<CommonParameters>]

Parameter

Description

UcsIPAddress

IP address or host name of the UCS to register

MachineType

Type of Operations Manager machine to register the UCS

MachineName

FQDN of the machine on which UCS is registered (all scripts related to this UCS MP will be run on this machine)

Port

Port number

Description

Optional description string for the UCS instance

ProxyHost

IP address or hostname of proxy server to be used for communicating with UCS

ProxyPort

Proxy port number

ProxyUsername

Username for proxy server

ProxyPassword

Password for proxy server

Get-UcsmScomAllInstances

Gets all existing UCS instances.

Get-UcsmScomAllInstances
[available in MP v4.1.5]

Update-UcsScomAllInstances Cmdlet

Updates all the existing UCS instances after upgrade from version 4.0(1) or higher.

Get-UcsScomDiscovery


Get-UcsScomDiscovery -InstanceName <string> 
Get-UcsScomDiscovery -InstanceName <string> -ClassName <string[]> 
Get-UcsScomDiscovery -InstanceName <string> -DiscoveryName <string[]>

Enable-UcsScomDiscovery


Enable-UcsScomDiscovery [-Discovery] <ManagementPackDiscovery[]>

Disable-UcsScomDiscovery


Disable-UcsScomDiscovery [-Discovery] <ManagementPackDiscovery[]>

Get-UcsScomRule


Get-UcsScomRule [[-Class] <string[]>] [[-FaultID] <string[]>]

Enable-UcsScomRule

Provide a name of management pack to which the override is added.


Enable-UcsScomRule [-Rule] <ManagementPackRule[]> 
[-ManagementPackName] <string>

Disable-UcsScomRule

Provide a name of management pack to which the override is added.


Disable-UcsScomRule [-Rule] <ManagementPackRule[]> 
[-ManagementPackName] <string>

Was this Document Helpful?

FeedbackFeedback

Contact Cisco