Cisco UCS Central 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
Available Languages
Download Options

Book Title

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

Chapter Title

PowerShell Cmdlets for Cisco UCS Central Management Pack

Results

Updated:
March 21, 2021

Chapter: PowerShell Cmdlets for Cisco UCS Central Management Pack

PowerShell Cmdlets for Cisco UCS Central Management Pack

This chapter contains the following section:

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 CiscoUcsCentralScomPs module is installed in %PROGRAMDATA%\Cisco\Modules.

Step 2

Import the CiscoUcsCentralScomPs module.
Step 3

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

Note 

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

Adding or Updating UCS Central Instances

Add-UcsCentralScomInstance

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-UcsCentralScomInstance -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>] 
[-ProxyHost <string>]
[-ProxyPort <int>] [-ProxyUsername <string>] 
[-ProxyPassword <string>] [-ExistingRunAsAccount <string>]
[-OrgDiscoveryLevel <int>] [-ShowUnassociatedProfiles] 
[-DisableUCSDomainsDiscovery]  [<CommonParameters>] 

Add-UcsCentralScomInstance -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>] [-ManagementPackName
<string>] [-Description <string>] [-ProxyHost 
<string>] [-ProxyPort <int>] [-ProxyUsername <string>]
[-ProxyPassword <string>] [-OrgDiscoveryLevel 
<int>] [-ShowUnassociatedProfiles] [-DisableUCSDomainsDiscovery]
[<CommonParameters>]  

Add-UcsCentralScomInstance -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>] 
[-ProxyHost <string>] [-ProxyPort <int>] 
[-ProxyUsername <string>]
[-ProxyPassword <string>] [-OrgDiscoveryLevel 
<int>] [-ShowUnassociatedProfiles] [-DisableUCSDomainsDiscovery]
[<CommonParameters>]  

Add-UcsCentralScomInstance -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>] [-ProxyHost
<string>] [-ProxyPort <int>] [-ProxyUsername <string>] 
[-ProxyPassword <string>] [-ExistingRunAsAccount <string>]
[-OrgDiscoveryLevel <int>] [-ShowUnassociatedProfiles] 
[-DisableUCSDomainsDiscovery]  [<CommonParameters>]

Parameter

Description

UcsIPAddress

IP address or host name of the UCS Central to register

MachineType

Type of Operations Manager machine to register the UCS Central

MachineName

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

InstanceName

Name to be given to this UCS Central 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 Central instance

NoSsl

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

ProxyHost

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

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

Example


$secureString =ConvertTo-SecureString "Nbv12#45" -AsPlainText –Force
$credentials = New-Object System.Management.Automation.PSCredential("admin", $secureString)
Add-UcsCentralScomInstance -UcsIPAddress "10.106.233.245" -MachineType 'Management Server' 
-MachineName 'SCOM2016RTMMS.qatcslab.cisco.com' -InstanceName 'CISCO_UCS_Central_MS' -RunAsAccount 'central245new' 
-RunAsCredential $credentials  -Port '443' -ManagementPackName 'CISCO_UCSC_MP_NEW' -Description "sampledescription" 
-OrgDiscoveryLevel 4 -ShowUnassociatedProfiles  -DisableUCSDomainsDiscovery

Update-UcsCentralScomInstance


Update-UcsCentralScomInstance [-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>]

Parameter

Description

UcsIPAddress

IP address or host name of the UCS Central to register

MachineType

Type of Operations Manager machine to register the UCS Central

MachineName

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

Port

Port number

Description

Optional description string for the UCS Central instance

ProxyHost

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

ProxyPort

Proxy port number

ProxyUsername

Username for proxy server

ProxyPassword

Password for proxy server

Example


Update-UcsCentralScomInstance -InstanceName ' CISCO_UCS_Central_MS ' -UcsIPAddress  "10.106.233.245" -Port '443'  
-MachineType  "Management Server"  -MachineName ' SCOM2016RTMMS.qatcslab.cisco.com '
-Description 'sample' -Secure $True –ProxyHost "10.65.183.85" -proxyport 808  -ProxyUsername 'scom' 
-ProxyPassword 'scom'  -OrgDiscoveryLevel 2

Get-UcsCentralScomAllInstances

Gets all existing UCS Central instances
[available in MP v4.1.5]

Get-UcsCentralScomDiscovery


Get-UcsCentralScomDiscovery -InstanceName <string> -ClassName <string[]>  [<CommonParameters>]

Example


Get-UcsCentralScomDiscovery -InstanceName "CISCO_UCS_Central_MS" -DiscoveryName "Organization Discovery"

Enable-UcsCentralScomDiscovery


Enable-UcsCentralScomDiscovery [-Discovery] <ManagementPackDiscovery[]>  [<CommonParameters>]

Example


$o = Get-UcsCentralScomDiscovery -InstanceName “CISCO_UCS_Central_MS” -ClassName 'Global Service Profile'
Enable-UcsCentralScomDiscovery -Discovery $o

Disable-UcsCentralScomDiscovery


Disable-UcsCentralScomDiscovery [-Discovery] <ManagementPackDiscovery[]>  [<CommonParameters>]

Example


$o = Get-UcsCentralScomDiscovery -InstanceName “CISCO_UCS_Central_MS” -ClassName 'Global Service Profile'
Disable-UcsCentralScomDiscovery -Discovery $o

Get-UcsCentralScomRule


Get-UcsCentralScomRule [[-Class] <string[]>] [[-FaultID] <string[]>]  [<CommonParameters>]

Example


Get-UcsCentralScomRule -class "Cisco UCs Central Instance"

Enable-UcsCentralScomRule

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


Enable-UcsCentralScomRule [-Rule] <ManagementPackRule[]> [-ManagementPackName] <string>  [<CommonParameters>]

Example


Enable-UcsCentralScomRule -Rule (Get-UcscentralscomRule -FaultID "F10000374")  -ManagementPackName 'CISCO_UCSC_MP'

Disable-UcsCentralScomRule

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


Disable-UcsCentralScomRule [-Rule] <ManagementPackRule[]> [-ManagementPackName] <string>  [<CommonParameters>]

Example


Disable-UcsCentralScomRule -Rule (Get-UcscentralscomRule -FaultID "F10000374") -ManagementPackName "Cisco Ucs Central Management Pack"

Was this Document Helpful?

FeedbackFeedback

Contact Cisco