Get-SCCertificate
Get-SCCertificate
Gets a security certificate object from a VMware vCenter Server, from a VMware ESX host, or from a Citrix XenServer host.
Syntax
Parameter Set: ByLocalFilename
Get-SCCertificate [-Filename] <String> [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ByRemoteComputer
Get-SCCertificate [-ComputerName] <String> [-TCPPort <UInt32> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Get-SCCertificate cmdlet gets a security certificate object from a vCenter Server, from an ESX host, or from a XenServer host. You can use this cmdlet to import a non-trusted certificate into Virtual Machine Manager (VMM) so that you can use the certificate with the Add-SCVirtualizationManager cmdlet, the Set-SCVirtualizationManager cmdlet, the Add-SCVMHost cmdlet or the Set-SCVMHost cmdlet.
The certificate is required in order to establish an SSL connection between the VMM server and the vCenter Server, ESX host, or XenServer host.
Parameters
-ComputerName<String>
Specifies the name of a computer that VMM can uniquely identify on your network. Valid formats are:
-- FQDN
-- IPv4 or IPv6 address
-- NetBIOS name
NOTE: See the examples for a specific cmdlet to determine how that cmdlet specifies the computer name.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Filename<String>
Specifies the file name to use when you rename a virtual hard disk file as you add it to a virtual machine.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TCPPort<UInt32>
Specifies a numeric value that represents a TCP port.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Certificate
Examples
Example Example 1: Retrieve the security certificate for the specified VMware vCenter Server.
This command gets the security certificate object for the vCenter Server server named vCenterServer01 located in the Contoso.com domain, and displays the security certificate information.
PS C:\> Get-SCCertificate -Computername "vCenterServer01.Contoso.com"
Example Example 2: Retrieve the security certificate for a specified VMware ESX host.
The first command gets the security certificate object from the ESX host named ESXHost01, and then stores the object in the $ESXCert variable.
The second command passes the contents of $ESXCert to the Get-Member cmdlet, which displays the .NET type and a list of methods and properties for the certificate object.
PS C:\> $ESXCert = Get-SCCertificate -ComputerName "ESXHost01.Contoso.com"
PS C:\> $ESXCert | Get-Member
Example Example 3: Retrieve the security certificate for the specified Citrix XenServer host.
This command gets the security certificate object for the XenServer named XenServer01 located in the Contoso.com domain, and displays the security certificate information.
PS C:\> Get-SCCertificate -Computername "XenServer01.Contoso.com"