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.
This chapter contains the following sections:
Before you install Cisco UCS Director PowerShell Agent, make sure that the following software has been installed on the machine:
Supported Windows operating system.
Supported .NET Framework (Full Package).
Configure WinRM on any device that the PowerShell Agent communicates with.
For more information about the system requirements and supported software, see the Compatibility Matrix for Cisco UCS Director.
The PowerShell Agent executes cmdlets and scripts on the target server in a PowerShell remote session. To accept remote PowerShell commands, enable Windows Remote Management (WinRM), change the startup type to Automatic, create a "listener" to respond to WinRS commands, and start the service on each computer you want to work with. This provides connectivity to Windows Remote Shell (WinRS), the client side of WS-Management protocol.
To enable WinRM, run a configuration command. The command creates a "listener" and also opens an exception for WinRM in Windows Firewall.
Step 1 | Open a command prompt, and enter the command:
winrm quickconfig You receive the following output: WinRM is not set up to allow remote access to this machine for management. The following changes must be made: Set the WinRM service type to delayed auto start. Start the WinRM service. Create a WinRM listener on HTTP://* to accept WS-Man requests to any IP on this machine. Enable the WinRM firewall exception. Make these changes [y/n]? | ||
Step 2 | Enter y.
You receive the following output: Make these changes [y/n]? y WinRM has been updated for remote management. WinRM service type changed successfully. WinRM service started. Created a WinRM listener on HTTP://* to accept WS-Man requests to any IP on this machine. WinRM firewall exception enabled. | ||
Step 3 | Verify that WinRM is enabled by executing the following command:
get-service winrm | ||
Step 4 | Configure the value " * " in the TrustedHosts table of WinRM by executing the following command:
winrm set winrm/config/client @{TrustedHosts="*"} When you are working with computers in workgroups or home groups, either use HTTPS as the transport or add the remote machine to the TrustedHosts configuration settings to enable authentication.
|
Make sure that the domain account used for connecting to a target server belongs to the local administrator group.
The PowerShell Agent listens for incoming requests on port 43891. This is the default port. Configure your machine's firewall to allow incoming TCP requests on any other port of your choice.
Cisco UCS Director services create an access key, that is used for secure communication on that port. Copy that key from the main Cisco UCS Director interface and enter it into the PowerShell Agent host.
Download the installer for PowerShell Agent from Cisco UCS Director to your native Windows machine.
Install Cisco UCS Director PowerShell Agent on your Windows machine.
Install the PowerShell Agent on your native Windows machine to enable the Cisco PSA service.
Installing a newer version of the PowerShell Agent requires that you uninstall the older version first. To remove the older version of PowerShell Agent, stop the Cisco PSA Service first and then uninstall the PowerShell agent. After uninstalling the PowerShell agent, navigate to the Cisco PSA Service folder (C:\Program Files (x86)\Cisco Systems\Cisco PSA Service) and check if any PSA files exist. If the PSA files remain in the Cisco PSA Service folder even after uninstallation, delete all the files.
Note | If you get the Error 1001 error message while uninstalling the PowerShell agent, delete the PSA registry folders. To delete the PSA registry folders, do the following:
|
Note | If you do not install the current version of PowerShell Agent for Cisco UCS Director on the Windows machine, some tasks or options on the PowerShell Agents tab are not available. |
By default, the PowerShell Agent uses port 43891 and it also uses a predefined authentication key to communicate with Cisco UCS Director. You can change these values by modifying the following file:
%AGENT_INSTALL_FOLDER%/props/properties.xml.
Download and install the Cisco UCS Director PowerShell Agent service on your target server.
If you change the default port, configure the firewall to match the new port.