netcoreapp2.0/VMware.VimAutomation.Security.Commands.dll-Help.xml
|
<?xml version="1.0" encoding="us-ascii"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-AttestationServiceInfo</command:name> <command:verb>Add</command:verb> <command:noun>AttestationServiceInfo</command:noun> <maml:description> <maml:para>This cmdlet adds an attestation service information, which comes from the TrustAuthorityAttestationService that runs in the Trust Authority system or its detailed information in the workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet adds an attestation service information, which comes from the TrustAuthorityAttestationService that runs in the Trust Authority system or its detailed information in the workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AttestationServiceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AttestationService</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority attestation services that you want to retrieve from the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityAttestationService[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityAttestationService[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AttestationServiceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ServiceAddress</maml:name> <maml:Description> <maml:para>Specifies the service address that you want to retrieve from the service address in the Trust Authority attestation service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies a file that stores the X509Chain data you want to use to connect to the Trust Authority attestation service.</maml:para> <maml:para>Either this parameter or the TrustedCA should be specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceGroup</maml:name> <maml:Description> <maml:para>Specifies the service group that you want to retrieve from the service group in the Trust Authority attestation service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePort</maml:name> <maml:Description> <maml:para>Specifies the number of the service port which is retrieved from the service port in the Trust Authority attestation service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TAClusterId</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster ID which you want to retrieve from the Trust Authority cluster ID in the running Trust Authority attestation service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrustedCA</maml:name> <maml:Description> <maml:para>Specifies the Trusted Certificate Authority which you want to retrieve from the Trusted Certificate Authority in the running Trust Authority attestation service in the Trust Authority system.</maml:para> <maml:para>Either this parameter or the FilePath should be specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Chain</command:parameterValue> <dev:type> <maml:name>X509Chain</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AttestationService</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority attestation services that you want to retrieve from the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityAttestationService[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityAttestationService[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies a file that stores the X509Chain data you want to use to connect to the Trust Authority attestation service.</maml:para> <maml:para>Either this parameter or the TrustedCA should be specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ServiceAddress</maml:name> <maml:Description> <maml:para>Specifies the service address that you want to retrieve from the service address in the Trust Authority attestation service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceGroup</maml:name> <maml:Description> <maml:para>Specifies the service group that you want to retrieve from the service group in the Trust Authority attestation service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePort</maml:name> <maml:Description> <maml:para>Specifies the number of the service port which is retrieved from the service port in the Trust Authority attestation service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TAClusterId</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster ID which you want to retrieve from the Trust Authority cluster ID in the running Trust Authority attestation service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrustedCA</maml:name> <maml:Description> <maml:para>Specifies the Trusted Certificate Authority which you want to retrieve from the Trusted Certificate Authority in the running Trust Authority attestation service in the Trust Authority system.</maml:para> <maml:para>Either this parameter or the FilePath should be specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Chain</command:parameterValue> <dev:type> <maml:name>X509Chain</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityAttestationService[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.AttestationServiceInfo</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$attestService = Get-TrustAuthorityAttestationService -Server trustAuthoritySystem Add-AttestationServiceInfo -AttesattionService $attestService -Server workloadSystem</dev:code> <dev:remarks> <maml:para>Adds the attestation service information to the workload vCenter Server system by specifying the TrustAuthorityAttesationService objects retrieved from the Trust Authority system.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$attestService = Get-TrustAuthorityAttestationService -Server trustAuthoritySystem | select -First 1 Add-AttestationServiceInfo -ServiceAddress $attestService.ServiceAddress -ServiceGroup $attestService.ServiceGroup -TAClusterId $attestService.TrustAuthorityClusterId -TrustedCA $attestService.TrustedCA -ServicePort $attestService.ServicePort -Server workloadSystem</dev:code> <dev:remarks> <maml:para>Adds the attestation service information to the workload vCenter Server system by specifying detailed information of the TrustAuthorityAttesationService running in the Trust Authority system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Add-AttestationServiceInfo.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustedClusterAttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustedClusterAttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityAttestationService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-KeyProviderServiceInfo</command:name> <command:verb>Add</command:verb> <command:noun>KeyProviderServiceInfo</command:noun> <maml:description> <maml:para>This cmdlet adds key provider service information, which comes from the Trust Authority key provider service running in the Trust Authority system or its detailed information in the workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet adds key provider service information, which comes from the Trust Authority key provider service running in the Trust Authority system or its detailed information in the workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-KeyProviderServiceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ServiceAddress</maml:name> <maml:Description> <maml:para>Specifies the service address which you want to retrieve from the service address in the Trust Authority key provider service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies a file that stores the X509Chain data that you want to use to connect to the Trust Authority key provider service.</maml:para> <maml:para>Either this parameter or the TrustedCA should be specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-CIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceGroup</maml:name> <maml:Description> <maml:para>Specifies the service group which you want to retrieve from the service group in the Trust Authority key provider service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePort</maml:name> <maml:Description> <maml:para>Specifies the number of the service port which you want to retrieve from the service port in the Trust Authority key provider service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TAClusterId</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster ID which you want to retrieve from the Trust Authority cluster ID in the running Trust Authority key provider service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrustedCA</maml:name> <maml:Description> <maml:para>Specifies the Trusted Certificate Authority that you want to retrieve from the Trusted Certificate Authority in the running Trust Authority key provider service in the Trust Authority system.</maml:para> <maml:para>Either this parameter or the FilePath should be specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Chain</command:parameterValue> <dev:type> <maml:name>X509Chain</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-KeyProviderServiceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>KeyProviderService</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider services that you want to retrieve from the Trust Authority System.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProviderService[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProviderService[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-CIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies a file that stores the X509Chain data that you want to use to connect to the Trust Authority key provider service.</maml:para> <maml:para>Either this parameter or the TrustedCA should be specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>KeyProviderService</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider services that you want to retrieve from the Trust Authority System.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProviderService[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProviderService[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-CIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ServiceAddress</maml:name> <maml:Description> <maml:para>Specifies the service address which you want to retrieve from the service address in the Trust Authority key provider service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceGroup</maml:name> <maml:Description> <maml:para>Specifies the service group which you want to retrieve from the service group in the Trust Authority key provider service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePort</maml:name> <maml:Description> <maml:para>Specifies the number of the service port which you want to retrieve from the service port in the Trust Authority key provider service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TAClusterId</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster ID which you want to retrieve from the Trust Authority cluster ID in the running Trust Authority key provider service in the Trust Authority system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrustedCA</maml:name> <maml:Description> <maml:para>Specifies the Trusted Certificate Authority that you want to retrieve from the Trusted Certificate Authority in the running Trust Authority key provider service in the Trust Authority system.</maml:para> <maml:para>Either this parameter or the FilePath should be specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Chain</command:parameterValue> <dev:type> <maml:name>X509Chain</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProviderService[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.KeyProviderServiceInfo</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$kmxService = Get-TrustAuthorityKeyProviderService -Server trustAuthoritySystem Add-KeyProviderServiceInfo -KeyProviderService $kmxService -Server workloadSystem</dev:code> <dev:remarks> <maml:para>Adds the key provider service information to the workload vCenter Server system by specifying the TrustAuthorityKeyProviderService objects that you want to retrieve from the Trust Authority system.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$kmxService = Get-TrustAuthorityKeyProviderService -Server trustAuthoritySystem | select -First 1 Add-AttestationServiceInfo -ServiceAddress $kmxService.ServiceAddress -ServiceGroup $kmxService.ServiceGroup -TAClusterId $kmxService.TrustAuthorityClusterId -TrustedCA $kmxService.TrustedCA -ServicePort $kmxService.ServicePort -Server workloadSystem</dev:code> <dev:remarks> <maml:para>Adds the key provider service information to the workload vCenter Server system by specifying detailed information of the Trust Authority key provider service that runs in the Trust Authority system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Add-KeyProviderServiceInfo.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-KeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustedClusterKeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustedClusterKeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-TrustAuthorityKeyProviderServer</command:name> <command:verb>Add</command:verb> <command:noun>TrustAuthorityKeyProviderServer</command:noun> <maml:description> <maml:para>This cmdlet adds a new Trust Authority key provider server to an existing Trust Authority key provider in the Trust Authority system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet adds a new Trust Authority key provider server to an existing Trust Authority key provider in the Trust Authority system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-TrustAuthorityKeyProviderServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider to which you want to add a new Trust Authority key provider Server.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Address</maml:name> <maml:Description> <maml:para>Specifies the address of the key provider server that you want to add.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the new Trust Authority key provider server. If it's not specified, the name is the same as the Address parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the number of the port that the Trust Authority key provider server uses to communicate with the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Address</maml:name> <maml:Description> <maml:para>Specifies the address of the key provider server that you want to add.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider to which you want to add a new Trust Authority key provider Server.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the new Trust Authority key provider server. If it's not specified, the name is the same as the Address parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the number of the port that the Trust Authority key provider server uses to communicate with the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProviderServer</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$kp = Get-TrustAuthorityKeyProvider -Name myProvider -TrustAuthorityCluster myCluster Add-TrustAuthorityKeyProviderServer -KeyProvider $kp -Address 1.1.1.1</dev:code> <dev:remarks> <maml:para>Adds a new Trust Authority key provider server with address 1.1.1.1 to the Trust Authority key provider named myProvider.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Add-TrustAuthorityKeyProviderServer.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityKeyProviderServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-TrustAuthorityKeyProviderServerCertificate</command:name> <command:verb>Add</command:verb> <command:noun>TrustAuthorityKeyProviderServerCertificate</command:noun> <maml:description> <maml:para>This cmdlet adds the certificate from the Trust Authority key provider server to be trusted by the Trust Authority key provider.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet adds the certificate from the Trust Authority key provider server to be trusted by the Trust Authority key provider.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-TrustAuthorityKeyProviderServerCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider to trust the specified certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Specifies the certificate to be trusted by the specified Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2[]</command:parameterValue> <dev:type> <maml:name>X509Certificate2[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-TrustAuthorityKeyProviderServerCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider to trust the specified certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies a file that stores the X509Certificate2 data which you want to be trusted by the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-TrustAuthorityKeyProviderServerCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>ServerCertificate</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider server certificate that you can trust.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProviderServerCertificate[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProviderServerCertificate[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Specifies the certificate to be trusted by the specified Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2[]</command:parameterValue> <dev:type> <maml:name>X509Certificate2[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies a file that stores the X509Certificate2 data which you want to be trusted by the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider to trust the specified certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>ServerCertificate</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider server certificate that you can trust.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProviderServerCertificate[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProviderServerCertificate[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProviderServerCertificate[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProviderServerCertificate</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$kps = Get-TrustAuthorityKeyProviderServer -KeyProvider myProvider | select -First 1 $serverCertificate = Get-TrustAuthorityKeyProviderServerCertificate -KeyProviderServer $kps Add-TrustAuthorityKeyProviderServerCertificate -ServerCertificate $serverCertificate</dev:code> <dev:remarks> <maml:para>Adds the $serverCertificate certificate which you can retrieve from the first Trust Authority key Provider server in the Trust Authority key provider named myProvider.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$kps = Get-TrustAuthorityKeyProviderServer -KeyProvider myProvider | select -First 1 $serverCertificate = Get-TrustAuthorityKeyProviderServerCertificate -KeyProviderServer $kps Add-TrustAuthorityKeyProviderServerCertificate -KeyProvider myProvider -Certificate $serverCertificate.Certificate</dev:code> <dev:remarks> <maml:para>Adds the certificate which you want to retrieve from the $serverCertificate certificate to be trusted by the Trust Authority key provider myProvider.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Add-TrustAuthorityKeyProviderServerCertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderServerCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityKeyProviderServerCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-TrustedClusterAttestationServiceInfo</command:name> <command:verb>Add</command:verb> <command:noun>TrustedClusterAttestationServiceInfo</command:noun> <maml:description> <maml:para>This cmdlet adds the attestation service information configured in the workload vCenter Server system to the trusted hosts in the given trusted cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet adds the attestation service information configured in the workload vCenter Server system to the trusted hosts in the given trusted cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-TrustedClusterAttestationServiceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustedCluster</maml:name> <maml:Description> <maml:para>Specifies the trusted cluster where you can configure the trusted hosts with the attestation service information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCluster</command:parameterValue> <dev:type> <maml:name>TrustedCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>AttestationServiceInfo</maml:name> <maml:Description> <maml:para>Specifies the attestation service information that you can configure in the workload vCenter Server system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AttestationServiceInfo[]</command:parameterValue> <dev:type> <maml:name>AttestationServiceInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>AttestationServiceInfo</maml:name> <maml:Description> <maml:para>Specifies the attestation service information that you can configure in the workload vCenter Server system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AttestationServiceInfo[]</command:parameterValue> <dev:type> <maml:name>AttestationServiceInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustedCluster</maml:name> <maml:Description> <maml:para>Specifies the trusted cluster where you can configure the trusted hosts with the attestation service information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCluster</command:parameterValue> <dev:type> <maml:name>TrustedCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustedCluster</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>When working with vCenter Server 7.0 Update 1 and later, this cmdlet might leave the trusted clusters unhealthy in the TrustedClusterAppliedStatus. For example, if the trusted clusters are already unhealthy in the TrustedClusterAppliedStatus, this operation does not change the healthy status of the trusted clusters. Use the Set-TrustedCluster cmdlet to remediate it afterwards.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$attestService = Get-AttestationServiceInfo Add-TrustedClusterAttestationServiceInfo -TrustedCluster myCluster -AttestationServiceInfo $attestService</dev:code> <dev:remarks> <maml:para>Adds the attestation service information configured in the workload vCenter Server system to the trusted hosts in the trusted cluster named myCluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Add-TrustedClusterAttestationServiceInfo.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustedClusterAttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TrustedCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedClusterAppliedStatus</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-TrustedClusterKeyProviderServiceInfo</command:name> <command:verb>Add</command:verb> <command:noun>TrustedClusterKeyProviderServiceInfo</command:noun> <maml:description> <maml:para>This cmdlet adds the key provider service information configured in the workload vCenter Server system to the trusted hosts in the given trusted cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet adds the key provider service information configured in the workload vCenter Server system to the trusted hosts in the given trusted cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-TrustedClusterKeyProviderServiceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustedCluster</maml:name> <maml:Description> <maml:para>Specifies the trusted cluster where you can configure the trusted hosts with the key provider service information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCluster</command:parameterValue> <dev:type> <maml:name>TrustedCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>KeyProviderServiceInfo</maml:name> <maml:Description> <maml:para>Specifies the key provider service information that you can configure in the workload vCenter Server system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">KeyProviderServiceInfo[]</command:parameterValue> <dev:type> <maml:name>KeyProviderServiceInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>KeyProviderServiceInfo</maml:name> <maml:Description> <maml:para>Specifies the key provider service information that you can configure in the workload vCenter Server system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">KeyProviderServiceInfo[]</command:parameterValue> <dev:type> <maml:name>KeyProviderServiceInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustedCluster</maml:name> <maml:Description> <maml:para>Specifies the trusted cluster where you can configure the trusted hosts with the key provider service information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCluster</command:parameterValue> <dev:type> <maml:name>TrustedCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustedCluster</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>When working with vCenter Server 7.0 Update 1 and later, this cmdlet might leave the trusted clusters unhealthy in the TrustedClusterAppliedStatus. For example, if the trusted clusters are already unhealthy in the TrustedClusterAppliedStatus, this operation does not change the healthy status of the trusted clusters. Use the Set-TrustedCluster cmdlet to remediate it afterwards.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$kmxService = Get-KeyProviderServiceInfo Add-TrustedClusterKeyProviderServiceInfo -TrustedCluster myCluster -KeyProviderServiceInfo $kmxService</dev:code> <dev:remarks> <maml:para>Adds the key provider service information configured in the workload vCenter Server system to the trusted hosts in the trusted cluster named myCluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Add-TrustedClusterKeyProviderServiceInfo.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-KeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustedClusterKeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TrustedCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedClusterAppliedStatus</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-Tpm2CACertificate</command:name> <command:verb>Export</command:verb> <command:noun>Tpm2CACertificate</command:noun> <maml:description> <maml:para>This cmdlet exports the CA certificate from either the certificate in the specified TPM 2.0 endorsement key or the specified certificate to a file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet exports the CA certificate from either the certificate in the specified TPM 2.0 endorsement key or the specified certificate to a file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-Tpm2CACertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Specifies the certificate from which you can export the CA certificate to a file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the CA certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Export-Tpm2CACertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Tpm2EndorsementKey</maml:name> <maml:Description> <maml:para>Specifies the TPM 2.0 endorsement key that you can use to retrieve the CA certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Tpm2EndorsementKey</command:parameterValue> <dev:type> <maml:name>Tpm2EndorsementKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the CA certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Specifies the certificate from which you can export the CA certificate to a file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the CA certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Tpm2EndorsementKey</maml:name> <maml:Description> <maml:para>Specifies the TPM 2.0 endorsement key that you can use to retrieve the CA certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Tpm2EndorsementKey</command:parameterValue> <dev:type> <maml:name>Tpm2EndorsementKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.Tpm2EndorsementKey</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This cmdlet does not work well on macOS. For more information, see https://github.com/dotnet/corefx/issues/41775#issuecomment-542035240.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$tpm2Ek = Get-Tpm2Endorsementkey -VMHost myHost Export-Tpm2CACertificate -Tpm2EndorsementKey $tpm2Ek -FilePath c:\myfile.zip</dev:code> <dev:remarks> <maml:para>Exports the CA certificate from the certificate in the $tpm2EK TPM 2.0 endorsement key that you can retrieve from the myHost host to the c:\myfile.zip file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$tpm2Ek = Get-Tpm2Endorsementkey -VMHost myHost Export-Tpm2CACertificate -Certificate $tpm2Ek.Certificate -FilePath c:\myfile.zip</dev:code> <dev:remarks> <maml:para>Exports the CA certificate from the specified $tpm2EK.Certificate certificate to the c:\myfile.zip file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Export-Tpm2CACertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-Tpm2EndorsementKey</command:name> <command:verb>Export</command:verb> <command:noun>Tpm2EndorsementKey</command:noun> <maml:description> <maml:para>This cmdlet exports the TPM 2.0 endorsement key from the TPM 2.0 chip in the specified host. It only works when you connect to the specified host directly by using the Connect-VIServer cmdlet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet exports the TPM 2.0 endorsement key from the TPM 2.0 chip in the specified host. It only works when you connect to the specified host directly by using the Connect-VIServer cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-Tpm2EndorsementKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Host"> <maml:name>VMHost</maml:name> <maml:Description> <maml:para>Specifies the hosts on which you want to export the TPM 2.0 endorsement key from its TPM 2.0 chip.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the TPM 2.0 endorsement key.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the TPM 2.0 endorsement key.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Host"> <maml:name>VMHost</maml:name> <maml:Description> <maml:para>Specifies the hosts on which you want to export the TPM 2.0 endorsement key from its TPM 2.0 chip.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.ViCore.Types.V1.Inventory.VMHost[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-VIServer -Server 1.1.1.1 -User myroot -Password mypassword Export-Tpm2EndorsementKey -VMHost 1.1.1.1 -Server 1.1.1.1 -FilePath c:\mypath</dev:code> <dev:remarks> <maml:para>Exports the TPM 2.0 endorsement key from the TPM 2.0 chip in the 1.1.1.1 host to the c:\mypath file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Export-Tpm2EndorsementKey.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-Tpm2CACertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-TrustAuthorityKeyProviderClientCertificate</command:name> <command:verb>Export</command:verb> <command:noun>TrustAuthorityKeyProviderClientCertificate</command:noun> <maml:description> <maml:para>This cmdlet exports the client certificate from the specified Trust Authority key provider to the specified file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet exports the client certificate from the specified Trust Authority key provider to the specified file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-TrustAuthorityKeyProviderClientCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider from which you can export the client certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the client certificate of the specified Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the client certificate of the specified Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider from which you can export the client certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Export-TrustAuthorityKeyProviderClientCertificate -KeyProvider myProvider -FilePath c:\mypath</dev:code> <dev:remarks> <maml:para>Exports the client certificate from the Trust Authority key provider myProvider to the c:\mypath file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Export-TrustAuthorityKeyProviderClientCertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderClientCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityKeyProviderClientCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-TrustAuthorityServicesInfo</command:name> <command:verb>Export</command:verb> <command:noun>TrustAuthorityServicesInfo</command:noun> <maml:description> <maml:para>This cmdlet exports the Trust Authority services information (the Trust Authority attestation service and Trust Authority key provider service) from the specified Trust Authority cluster to the specified file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet exports the Trust Authority services information (the Trust Authority attestation service and Trust Authority key provider service) from the specified Trust Authority cluster to the specified file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-TrustAuthorityServicesInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where you can export the the Trust Authority services information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the Trust Authority services information from the specified Trust Authority cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the Trust Authority services information from the specified Trust Authority cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where you can export the the Trust Authority services information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Export-TrustAuthorityServicesInfo -TrustAuthorityCluster mycluster -FilePath c:\mypath</dev:code> <dev:remarks> <maml:para>Exports the Trust Authority services information (the Trust Authority attestation service and Trust Authority key provider service) from the mycluster Trust Authority Cluster to the c:\mypath file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Export-TrustAuthorityServicesInfo.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-TrustAuthorityServicesInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityAttestationService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-TrustedPrincipal</command:name> <command:verb>Export</command:verb> <command:noun>TrustedPrincipal</command:noun> <maml:description> <maml:para>This cmdlet exports the trusted principal from the single or the specified connected workload vCenter Server system to the specified file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet exports the trusted principal from the single or the specified connected workload vCenter Server system to the specified file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-TrustedPrincipal</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the trusted principal from the workload vCenter Server system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the trusted principal from the workload vCenter Server system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Export-TrustedPrincipal -FilePath c:\mypath.</dev:code> <dev:remarks> <maml:para>Exports the trusted principal from the connected workload vCenter Server system to the c:\mypath file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Export-TrustedPrincipal.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-VMHostImageDb</command:name> <command:verb>Export</command:verb> <command:noun>VMHostImageDb</command:noun> <maml:description> <maml:para>This cmdlet exports the specified host's base image database to a file that is in a .tgz format.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet exports the specified host's base image database to a file that is in a .tgz format.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-VMHostImageDb</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Host"> <maml:name>VMHost</maml:name> <maml:Description> <maml:para>Specifies the host from which you want to export the base image database.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the base image database from the specified host.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to export the base image database from the specified host.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites the existing destination files and creates directories to complete the specified file path.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Host"> <maml:name>VMHost</maml:name> <maml:Description> <maml:para>Specifies the host from which you want to export the base image database.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.ViCore.Types.V1.Inventory.VMHost[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Export-VMHostImageDb -VMHost myHost -FilePath c:\mypath</dev:code> <dev:remarks> <maml:para>Exports the base image database from the myHost host to the c:\mypath file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Export-VMHostImageDb.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AttestationServiceInfo</command:name> <command:verb>Get</command:verb> <command:noun>AttestationServiceInfo</command:noun> <maml:description> <maml:para>This cmdlet retrieves the attestation services information configured in the workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the attestation services information configured in the workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AttestationServiceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the attestation service information you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AttestationServiceInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceAddress</maml:name> <maml:Description> <maml:para>Specifies the service addresses of the attestation service information you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceGroup</maml:name> <maml:Description> <maml:para>Specifies the service groups of the attestation service information you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePort</maml:name> <maml:Description> <maml:para>Specifies the service port of the attestation service information you want to retrieve. It only works when the ServiceAddress parameter is also specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TAClusterId</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster IDs of the attestation service information you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the attestation service information you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceAddress</maml:name> <maml:Description> <maml:para>Specifies the service addresses of the attestation service information you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceGroup</maml:name> <maml:Description> <maml:para>Specifies the service groups of the attestation service information you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePort</maml:name> <maml:Description> <maml:para>Specifies the service port of the attestation service information you want to retrieve. It only works when the ServiceAddress parameter is also specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TAClusterId</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster IDs of the attestation service information you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.AttestationServiceInfo[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-AttestationServiceInfo</dev:code> <dev:remarks> <maml:para>Retrieves a list of the available attestation service information configured in the workload vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-AttestationServiceInfo.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-TrustAuthorityServicesInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-KeyProviderServiceInfo</command:name> <command:verb>Get</command:verb> <command:noun>KeyProviderServiceInfo</command:noun> <maml:description> <maml:para>This cmdlet retrieves the key provider services information configured in the workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the key provider services information configured in the workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-KeyProviderServiceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the key provider service information you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-KeyProviderServiceInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceAddress</maml:name> <maml:Description> <maml:para>Specifies the service addresses of the key provider service information you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceGroup</maml:name> <maml:Description> <maml:para>Specifies the service groups of the key provider service information you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePort</maml:name> <maml:Description> <maml:para>Specifies the service port of the key provider service information you want to retrieve. It only works when the ServiceAddress parameter is also specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TAClusterId</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster IDs of the key provider service information you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the key provider service information you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceAddress</maml:name> <maml:Description> <maml:para>Specifies the service addresses of the key provider service information you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceGroup</maml:name> <maml:Description> <maml:para>Specifies the service groups of the key provider service information you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePort</maml:name> <maml:Description> <maml:para>Specifies the service port of the key provider service information you want to retrieve. It only works when the ServiceAddress parameter is also specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TAClusterId</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster IDs of the key provider service information you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.KeyProviderServiceInfo[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-KeyProviderServiceInfo</dev:code> <dev:remarks> <maml:para>Retrieves a list of the available key provider service information configured in the workload vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-KeyProviderServiceInfo.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-KeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-KeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-TrustAuthorityServicesInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SecurityInfo</command:name> <command:verb>Get</command:verb> <command:noun>SecurityInfo</command:noun> <maml:description> <maml:para>This cmdlet retrieves the security information of objects (VirtualMachine, HardDisk or VMHost).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the security information of objects. Returns the SecurityInfo instance that corresponds to the specified object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SecurityInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Entity</maml:name> <maml:Description> <maml:para>Specifies the object to retrieve its security information. Supported objects are VirtualMachine, VMHost and HardDisk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIObjectCore[]</command:parameterValue> <dev:type> <maml:name>VIObjectCore[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the connected viserver on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default viservers. For more information about default viservers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Entity</maml:name> <maml:Description> <maml:para>Specifies the object to retrieve its security information. Supported objects are VirtualMachine, VMHost and HardDisk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIObjectCore[]</command:parameterValue> <dev:type> <maml:name>VIObjectCore[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the connected viserver on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default viservers. For more information about default viservers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Sdk.Types.V1.VIObjectCore[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.SecurityInfo.SecurityInfo</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The supported entities are only VirtualMachine, HardDisk and VMHost.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-SecurityInfo -Entity MyObj*</dev:code> <dev:remarks> <maml:para>Retrieves the security information of all the virtual machines and all the VMHosts whose names starting with "MyObj".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VM MyVM | Get-HardDisk | Get-SecurityInfo</dev:code> <dev:remarks> <maml:para>Retrieves security information of all disks of 'MyVM' virtual machine.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$vmHosts = Get-VMHost Get-SecurityInfo -Entity $vmHosts</dev:code> <dev:remarks> <maml:para>Retrieves security information of all the VMHosts available on the connected servers.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$myVm1 = Get-VM -Name MyVM1 $myVm2 = Get-VM -Name MyVM2 Get-SecurityInfo -Entity $myVM1, $myVM2</dev:code> <dev:remarks> <maml:para>Retrieves security information of the given two virtual machines.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Unblock-VM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Tpm2EndorsementKey</command:name> <command:verb>Get</command:verb> <command:noun>Tpm2EndorsementKey</command:noun> <maml:description> <maml:para>This cmdlet retrieves the TPM 2.0 endorsement key from the TPM 2.0 chip in the specified host. It only works when connecting to the specified host directly using the Connect-VIServer cmdlet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the TPM 2.0 endorsement key from the TPM 2.0 chip in the specified host. It only works when connecting to the specified host directly using the Connect-VIServer cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Tpm2EndorsementKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Host"> <maml:name>VMHost</maml:name> <maml:Description> <maml:para>Specifies the hosts on which you want to export the TPM 2.0 endorsement key from the TPM 2.0 chip.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Host"> <maml:name>VMHost</maml:name> <maml:Description> <maml:para>Specifies the hosts on which you want to export the TPM 2.0 endorsement key from the TPM 2.0 chip.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.ViCore.Types.V1.Inventory.VMHost[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.Tpm2EndorsementKey</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-VIServer -Server 1.1.1.1 -User myroot -Password mypassword Get-Tpm2EndorsementKey -VMHost 1.1.1.1 -Server 1.1.1.1</dev:code> <dev:remarks> <maml:para>Retrieves the TPM 2.0 endorsement key information from the TPM 2.0 chip in the 1.1.1.1 host.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-Tpm2EndorsementKey.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-Tpm2CACertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityAttestationService</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityAttestationService</command:noun> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority attestation services from the specified enabled Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority attestation services from the specified enabled Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityAttestationService</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Autority cluster where you can find the Trust Authority attestation services you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Host"> <maml:name>VMHost</maml:name> <maml:Description> <maml:para>Specifies the host from which you can retrieve the Trust Authority attestation services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceAddress</maml:name> <maml:Description> <maml:para>Specifies the service addresses of the Trust Authority attestation services you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceGroup</maml:name> <maml:Description> <maml:para>Specifies the service groups of the Trust Authority attestation services you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceAddress</maml:name> <maml:Description> <maml:para>Specifies the service addresses of the Trust Authority attestation services you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceGroup</maml:name> <maml:Description> <maml:para>Specifies the service groups of the Trust Authority attestation services you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Autority cluster where you can find the Trust Authority attestation services you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Host"> <maml:name>VMHost</maml:name> <maml:Description> <maml:para>Specifies the host from which you can retrieve the Trust Authority attestation services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.ViCore.Types.V1.Inventory.VMHost[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityAttestationService[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-TrustAuthorityCluster -TrustAuthorityCluster mycluster -State Enabled Get-TrustAuthorityAttestationService -TrustAuthorityCluster mycluster</dev:code> <dev:remarks> <maml:para>Retrieves the Trust Authority attestation services from the mycluster Trust Authority cluster after you enable it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityAttestationService.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-TrustAuthorityServicesInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityCluster</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityCluster</command:noun> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority clusters from the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority clusters from the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the Trust Authority cluster you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TrustAuthorityCluster</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the Trust Authority clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>State</maml:name> <maml:Description> <maml:para>Specifies the state of the Trust Authority clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">TrustAuthorityState</command:parameterValue> <dev:type> <maml:name>TrustAuthorityState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the Trust Authority cluster you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the Trust Authority clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>State</maml:name> <maml:Description> <maml:para>Specifies the state of the Trust Authority clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityState</command:parameterValue> <dev:type> <maml:name>TrustAuthorityState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustAuthorityCluster</dev:code> <dev:remarks> <maml:para>Retrieves the Trust Authority clusters from the connected Trust Authority vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityCluster.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TrustAuthorityCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityKeyProvider</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityKeyProvider</command:noun> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority key providers from the specified Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority key providers from the specified Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityKeyProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters where you can retrieve the Trust Authority key providers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the Trust Authority key providers you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the Trust Authority key providers you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters where you can retrieve the Trust Authority key providers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustAuthorityKeyProvider -TrustAuthorityCluster mycluster</dev:code> <dev:remarks> <maml:para>Retrieves the Trust Authority key providers from the mycluster Trust Authority cluster in the connected Trust Authority vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityKeyProvider.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityKeyProviderClientCertificate</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityKeyProviderClientCertificate</command:noun> <maml:description> <maml:para>This cmdlet retrieves the client certificate from the specified Trust Authority key provider in the connected Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the client certificate from the specified Trust Authority key provider in the connected Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityKeyProviderClientCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers from which you want to retrieve the client certificates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers from which you want to retrieve the client certificates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Security.Cryptography.X509Certificates.X509Certificate2</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustAuthorityKeyProviderClientCertificate -KeyProvider myKeyProvider</dev:code> <dev:remarks> <maml:para>Retrieves the client certificate from the myKeyProvider Trust Authority key provider.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityKeyProviderClientCertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityKeyProviderClientCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-TrustAuthorityKeyProviderClientCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TrustAuthorityKeyProviderClientCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityKeyProviderClientCertificateCSR</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityKeyProviderClientCertificateCSR</command:noun> <maml:description> <maml:para>This cmdlet retrieves the client certificate Certificate Signing Request (CSR) from the specified Trust Authority key provider in the connected Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the client certificate Certificate Signing Request (CSR) from the specified Trust Authority key provider in the connected Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityKeyProviderClientCertificateCSR</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers from where you want to retrieve the client certificate CSRs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers from where you want to retrieve the client certificate CSRs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustAuthorityKeyProviderClientCertificateCSR -KeyProvider myKeyProvider</dev:code> <dev:remarks> <maml:para>Retrieves the client certificate CSR from the Trust Authority myKeyProvider key provider.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityKeyProviderClientCertificateCSR.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityKeyProviderClientCertificateCSR</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityKeyProviderServer</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityKeyProviderServer</command:noun> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority key provider servers from the specified Trust Authority key providers in the connected Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority key provider servers from the specified Trust Authority key providers in the connected Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityKeyProviderServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers from where you want to retrieve the Trust Authority key provider servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Address</maml:name> <maml:Description> <maml:para>Specifies the addresses of the Trust Authority key provider server you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TrustAuthorityKeyProviderServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers from where you want to retrieve the Trust Authority key provider servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the Trust Authority key provider server you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Address</maml:name> <maml:Description> <maml:para>Specifies the addresses of the Trust Authority key provider server you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers from where you want to retrieve the Trust Authority key provider servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the Trust Authority key provider server you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProviderServer[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustAuthorityKeyProviderServer -KeyProvider myKeyProvider -Address 1.1.1.1</dev:code> <dev:remarks> <maml:para>Retrieves the Trust Authority key provider server with the 1.1.1.1 address from the Trust Authority myKeyProvider key provider.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-TrustAuthorityKeyProviderServer -KeyProvider myKeyProvider -Name myKmsName</dev:code> <dev:remarks> <maml:para>Retrieves the Trust Authority key provider server with name myKmsName from the Trust Authority key provider myKeyProvider.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityKeyProviderServer.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustAuthorityKeyProviderServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityKeyProviderServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityKeyProviderServerCertificate</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityKeyProviderServerCertificate</command:noun> <maml:description> <maml:para>This cmdlet retrieves the certificate from the Trust Authority key provider server or the certificate trusted by the specified Trust Authority key provider in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the certificate from the Trust Authority key provider server or the certificate trusted by the specified Trust Authority key provider in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityKeyProviderServerCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers from which you want to retrieve the trusted certificates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TrustAuthorityKeyProviderServerCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>KeyProviderServer</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider servers from which you want to retrieve the certificates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProviderServer[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProviderServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers from which you want to retrieve the trusted certificates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>KeyProviderServer</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider servers from which you want to retrieve the certificates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProviderServer[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProviderServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProviderServer[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProviderServerCertificate[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$kmsServer = Get-TrustAuthorityKeyProviderServer -KeyProvider myProvider Get-TrustAuthorityKeyProviderServerCertificate -KeyProviderServer $kmsServer</dev:code> <dev:remarks> <maml:para>Retrieves the certificates from the Trust Authority key provider server in the Trust Authority key provider myProvider.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-TrustAuthorityKeyProviderServerCertificate -KeyProvider myProvider</dev:code> <dev:remarks> <maml:para>Retrieves the certificates that are trusted by the Trust Authority key provider myProvider.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityKeyProviderServerCertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustAuthorityKeyProviderServerCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityKeyProviderServerCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityKeyProviderService</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityKeyProviderService</command:noun> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority key provider services from the specified enabled Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority key provider services from the specified enabled Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityKeyProviderService</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Autority clusters from which you want to retrieve the Trust Authority key provider services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Host"> <maml:name>VMHost</maml:name> <maml:Description> <maml:para>Specifies the hosts from which you want to retrieve the Trust Authority key provider services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceAddress</maml:name> <maml:Description> <maml:para>Specifies the service addresses of the Trust Authority key provider services you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceGroup</maml:name> <maml:Description> <maml:para>Specifies the service groups of the Trust Authority key provider services you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceAddress</maml:name> <maml:Description> <maml:para>Specifies the service addresses of the Trust Authority key provider services you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceGroup</maml:name> <maml:Description> <maml:para>Specifies the service groups of the Trust Authority key provider services you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Autority clusters from which you want to retrieve the Trust Authority key provider services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Host"> <maml:name>VMHost</maml:name> <maml:Description> <maml:para>Specifies the hosts from which you want to retrieve the Trust Authority key provider services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.ViCore.Types.V1.Inventory.VMHost[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProviderService[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-TrustAuthorityCluster -TrustAuthorityCluster mycluster -State Enabled Get-TrustAuthorityKeyProviderService -TrustAuthorityCluster mycluster</dev:code> <dev:remarks> <maml:para>Retrieves the Trust Authority key provider services from the Trust Authority mycluster cluster after you enable it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityKeyProviderService.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityAttestationService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-TrustAuthorityServicesInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityPrincipal</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityPrincipal</command:noun> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority principals from the specified Trust Authority clusters in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority principals from the specified Trust Authority clusters in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityPrincipal</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters from where you want to retrieve the Trust Authority principals.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Domain</maml:name> <maml:Description> <maml:para>Specifies the domain of the Trust Authority principals you want to retrieve. It only works together with the Name parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Issuer</maml:name> <maml:Description> <maml:para>Specifies the issuers of the Trust Authority principals you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the Trust Authority principals you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TrustAuthorityPrincipal</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the Trust Authority principals you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Domain</maml:name> <maml:Description> <maml:para>Specifies the domain of the Trust Authority principals you want to retrieve. It only works together with the Name parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the Trust Authority principals you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Issuer</maml:name> <maml:Description> <maml:para>Specifies the issuers of the Trust Authority principals you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the Trust Authority principals you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters from where you want to retrieve the Trust Authority principals.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityPrincipal[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustAuthorityPrincipal -TrustAuthorityCluster mycluster -Name myprincipal</dev:code> <dev:remarks> <maml:para>Retrieves the Trust Authority principal with name myprincipal from the Trust Authority cluster mycluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityPrincipal.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-TrustedPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityServicesStatus</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityServicesStatus</command:noun> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority services status from the specified Trust Authority clusters in the connected Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority services status from the specified Trust Authority clusters in the connected Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityServicesStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters from which you want to retrieve the Trust Authority services status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters from which you want to retrieve the Trust Authority services status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityServicesStatus</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustAuthorityServicesStatus -TrustAuthorityCluster mycluster</dev:code> <dev:remarks> <maml:para>Retrieves the Trust Authority services status from the Trust Authority cluster mycluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityServicesStatus.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityTpm2AttestationSettings</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityTpm2AttestationSettings</command:noun> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority TPM 2.0 attestation settings from the specified Trust Authority clusters in the connected Trust Auhtority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority TPM 2.0 attestation settings from the specified Trust Authority clusters in the connected Trust Auhtority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityTpm2AttestationSettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters from which you want to retrieve the Trust Authority TPM 2.0 attestation settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters from which you want to retrieve the Trust Authority TPM 2.0 attestation settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityTpm2AttestationSettings[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustAuthorityTpm2AttestationSettings -TrustAuthorityCluster mycluster</dev:code> <dev:remarks> <maml:para>Retrieves the Trust Authority TPM 2.0 attestation settings from the Trust Authority cluster mycluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityTpm2AttestationSettings.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TrustAuthorityTpm2AttestationSettings</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityTpm2CACertificate</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityTpm2CACertificate</command:noun> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority TPM 2.0 Certificate Authority (CA) certificates from the specified Trust Authority clusters in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority TPM 2.0 Certificate Authority (CA) certificates from the specified Trust Authority clusters in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityTpm2CACertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the Trust Authority TPM 2.0 CA certificates you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TrustAuthorityTpm2CACertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters from which you want to retrieve the Trust Authority TPM 2.0 CA certificates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the Trust Authority TPM 2.0 CA certificates you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the Trust Authority TPM 2.0 CA certificates you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the Trust Authority TPM 2.0 CA certificates you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters from which you want to retrieve the Trust Authority TPM 2.0 CA certificates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityTpm2CACertificate[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustAuthorityTpm2CACertificate -TrustAuthorityCluster mycluster</dev:code> <dev:remarks> <maml:para>Retrieves the Trust Authority TPM 2.0 CA certificates from the Trust Authority cluster mycluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityTpm2CACertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityTpm2CACertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityTpm2CACertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-Tpm2CACertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityTpm2EndorsementKey</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityTpm2EndorsementKey</command:noun> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority TPM 2.0 endorsement keys from the specified Trust Authority clusters in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority TPM 2.0 endorsement keys from the specified Trust Authority clusters in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityTpm2EndorsementKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the Trust Authority TPM 2.0 endorsement keys you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TrustAuthorityTpm2EndorsementKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters from which you want to retrieve the Trust Authority TPM 2.0 endorsement keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the Trust Authority TPM 2.0 endorsement keys you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the Trust Authority TPM 2.0 endorsement keys you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the Trust Authority TPM 2.0 endorsement keys you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters from which you want to retrieve the Trust Authority TPM 2.0 endorsement keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityTpm2EndorsementKey[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustAuthorityTpm2EndorsementKey -TrustAuthorityCluster mycluster</dev:code> <dev:remarks> <maml:para>Retrieves the Trust Authority TPM 2.0 endorsement keys from the Trust Authority cluster mycluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityTpm2EndorsementKey.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityTpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityTpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-Tpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustAuthorityVMHostBaseImage</command:name> <command:verb>Get</command:verb> <command:noun>TrustAuthorityVMHostBaseImage</command:noun> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority virtual machine host base image from the specified Trust Authority clusters in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the Trust Authority virtual machine host base image from the specified Trust Authority clusters in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustAuthorityVMHostBaseImage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters from which you want to retrieve the Trust Authority virtual machine host base images.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Health</maml:name> <maml:Description> <maml:para>Specifies the healths of the Trust Authority virtual machine host base images you want to retrieve.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ok</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">TrustAuthoritySettingsConfigHealth[]</command:parameterValue> <dev:type> <maml:name>TrustAuthoritySettingsConfigHealth[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VMHostVersion</maml:name> <maml:Description> <maml:para>Specifies the virtual machine host versions of the Trust Authority virtual machine host base images you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TrustAuthorityVMHostBaseImage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the Trust Authority virtual machine host base image you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Health</maml:name> <maml:Description> <maml:para>Specifies the healths of the Trust Authority virtual machine host base images you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthoritySettingsConfigHealth[]</command:parameterValue> <dev:type> <maml:name>TrustAuthoritySettingsConfigHealth[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the Trust Authority virtual machine host base image you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters from which you want to retrieve the Trust Authority virtual machine host base images.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VMHostVersion</maml:name> <maml:Description> <maml:para>Specifies the virtual machine host versions of the Trust Authority virtual machine host base images you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityVMHostBaseImage[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustAuthorityVMHostBaseImage -TrustAuthorityCluster mycluster</dev:code> <dev:remarks> <maml:para>Retrieves the Trust Authority virtual machine host base image from the Trust Authority cluster mycluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustAuthorityVMHostBaseImage.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityVMHostBaseImage</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityVMHostBaseImage</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-VMHostImageDb</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustedCluster</command:name> <command:verb>Get</command:verb> <command:noun>TrustedCluster</command:noun> <maml:description> <maml:para>This cmdlet retrieves the trusted clusters from the connected workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the trusted clusters from the connected workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustedCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the trusted cluster you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TrustedCluster</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the trusted clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>State</maml:name> <maml:Description> <maml:para>Specifies the state of the trusted clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">TrustedState</command:parameterValue> <dev:type> <maml:name>TrustedState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the trusted cluster you want to retrieve.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the trusted clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>State</maml:name> <maml:Description> <maml:para>Specifies the state of the trusted clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedState</command:parameterValue> <dev:type> <maml:name>TrustedState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustedCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustedCluster -Name mycluster</dev:code> <dev:remarks> <maml:para>Retrieves the trusted cluster with a name mycluster from the connected workload vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustedCluster.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TrustedCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustedClusterAttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustedClusterKeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustedClusterAttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustedClusterKeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustedClusterAppliedStatus</command:name> <command:verb>Get</command:verb> <command:noun>TrustedClusterAppliedStatus</command:noun> <maml:description> <maml:para>This cmdlet retrieves the applied status of the trusted service information on the trusted clusters in the workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the applied status of the trusted service information on the trusted clusters in the workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustedClusterAppliedStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustedCluster</maml:name> <maml:Description> <maml:para>Specifies the trusted cluster where you can retrieve the applied status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCluster[]</command:parameterValue> <dev:type> <maml:name>TrustedCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustedCluster</maml:name> <maml:Description> <maml:para>Specifies the trusted cluster where you can retrieve the applied status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCluster[]</command:parameterValue> <dev:type> <maml:name>TrustedCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustedCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more TrustedClusterAppliedStatus objects</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This cmdlet is only available for the vCenter Server system 7.0 Update 1 and above.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustedClusterAppliedStatus -TrustedCluster mycluster</dev:code> <dev:remarks> <maml:para>Retrieves the applied status from the mycluster trusted cluster in the connected workload vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustedClusterAppliedStatus.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TrustedCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TrustedPrincipal</command:name> <command:verb>Get</command:verb> <command:noun>TrustedPrincipal</command:noun> <maml:description> <maml:para>This cmdlet retrieves the trusted principals from the connected workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the trusted principals from the connected workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TrustedPrincipal</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustedPrincipal</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-TrustedPrincipal</dev:code> <dev:remarks> <maml:para>Retrieves the trusted principals from the connected workload vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-TrustedPrincipal.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-TrustedPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VTpm</command:name> <command:verb>Get</command:verb> <command:noun>VTpm</command:noun> <maml:description> <maml:para>This cmdlet retrieves the virtual TPM (vTPM) devices available on the given virtual machines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the virtual TPM (vTPM) devices available on the given virtual machines. This cmdlet returns vTPM devices that correspond to the filter criteria specified by the provided parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VTpm</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the vTPM device that you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VTpm</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>VM</maml:name> <maml:Description> <maml:para>Specifies the virtual machines from which you want to retrieve the vTPM device.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VirtualMachine[]</command:parameterValue> <dev:type> <maml:name>VirtualMachine[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the vTPM device that you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>VM</maml:name> <maml:Description> <maml:para>Specifies the virtual machines from which you want to retrieve the vTPM device.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VirtualMachine[]</command:parameterValue> <dev:type> <maml:name>VirtualMachine[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VTpm objects</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$vm = Get-VM "MyVM" Get-VTpm -VM $vm</dev:code> <dev:remarks> <maml:para>Retrieves the vTPM device of the virtual machine named "MyVM".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VTpm.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpmCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpmCSR</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VTpmCertificate</command:name> <command:verb>Get</command:verb> <command:noun>VTpmCertificate</command:noun> <maml:description> <maml:para>This cmdlet retrieves the certificate information from the given vTPM devices.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the certificate information from the given vTPM devices. You can retrive the certificate information from the given vTPM devices by specifying the vTPM device and the certificate signing request type (CSRType): RSA, ECC, or All. By default, the certificate signing request type (CSRType) is All.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VTpmCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VTpm</maml:name> <maml:Description> <maml:para>Specifies the vTPM device from which you want to retrieve the certificate information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VTpm[]</command:parameterValue> <dev:type> <maml:name>VTpm[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CSRType</maml:name> <maml:Description> <maml:para>Specifies the signing request type of the certificate. The valid values are All, ECC, and RSA.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ECC</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RSA</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CSRType</command:parameterValue> <dev:type> <maml:name>CSRType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CSRType</maml:name> <maml:Description> <maml:para>Specifies the signing request type of the certificate. The valid values are All, ECC, and RSA.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CSRType</command:parameterValue> <dev:type> <maml:name>CSRType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VTpm</maml:name> <maml:Description> <maml:para>Specifies the vTPM device from which you want to retrieve the certificate information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VTpm[]</command:parameterValue> <dev:type> <maml:name>VTpm[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.Entity.VTpm[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Security.Cryptography.X509Certificates.X509Certificate2Collection</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-VTpm -VM MyVM | Get-VTpmCertificate</dev:code> <dev:remarks> <maml:para>Retrieves all the certificate information from the vTPM device of the virtual machine named "MyVM".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-VTpm -VM MyVM | Get-VTpmCertificate -CSRType ECC</dev:code> <dev:remarks> <maml:para>Retrieves the certificate information, whose encryption algorithm is ECC, from the vTPM device of the virtual machine named "MyVM".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VTpmCertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpmCSR</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VTpmCSR</command:name> <command:verb>Get</command:verb> <command:noun>VTpmCSR</command:noun> <maml:description> <maml:para>This cmdlet retrieves the certficate signing requests (CSR) from the given vTPM devices.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the certficate signing requests (CSR) from the given vTPM devices. You can retrive the certificate signing request from the given vTPM devices by specifying the vTPM device and the certificate signing request type (CSRType): RSA, ECC, or All. By default, the certificate signing request type (CSRType) is All.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VTpmCSR</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VTpm</maml:name> <maml:Description> <maml:para>Specifies the vTPM device from which you want to retrieve the certificate signing request information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VTpm[]</command:parameterValue> <dev:type> <maml:name>VTpm[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CSRType</maml:name> <maml:Description> <maml:para>Specifies the signing request type. The valid values are: All, ECC, RSA.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ECC</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RSA</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CSRType</command:parameterValue> <dev:type> <maml:name>CSRType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CSRType</maml:name> <maml:Description> <maml:para>Specifies the signing request type. The valid values are: All, ECC, RSA.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CSRType</command:parameterValue> <dev:type> <maml:name>CSRType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VTpm</maml:name> <maml:Description> <maml:para>Specifies the vTPM device from which you want to retrieve the certificate signing request information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VTpm[]</command:parameterValue> <dev:type> <maml:name>VTpm[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.Entity.VTpm[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>PS C:\> Get-VTpm -VM MyVM | Get-VTpmCSR</dev:code> <dev:remarks> <maml:para>Retrieves all the certificate signing request information from the vTPM device of the virtual machine named "MyVM".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-VTpm -VM MyVM | Get-VTpmCSR -CSRType ECC</dev:code> <dev:remarks> <maml:para>Retrieves the certificate signing request information, whose encryption algorithm is ECC, from the vTPM device of the virtual machine named "MyVM".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VTpmCSR.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpmCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-TrustAuthorityServicesInfo</command:name> <command:verb>Import</command:verb> <command:noun>TrustAuthorityServicesInfo</command:noun> <maml:description> <maml:para>This cmdlet imports the Trust Authority services information (Trust Authority attestation service and Trust Authority key provider service) from the specified file to the workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet imports the Trust Authority services information (Trust Authority attestation service and Trust Authority key provider service) from the specified file to the workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-TrustAuthorityServicesInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to import the Trust Authority services information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the path to the file where you want to import the Trust Authority services information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TAServiceInfo[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Import-TrustAuthorityServicesInfo -FilePath c:\mypath</dev:code> <dev:remarks> <maml:para>Imports the Trust Authority services information in the c:\mypath file to the connected workload vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Import-TrustAuthorityServicesInfo.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-TrustAuthorityServicesInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-TrustAuthorityKeyProvider</command:name> <command:verb>New</command:verb> <command:noun>TrustAuthorityKeyProvider</command:noun> <maml:description> <maml:para>This cmdlet creates a new Trust Authority key provider in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new Trust Authority key provider in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-TrustAuthorityKeyProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionTimeOutSeconds</maml:name> <maml:Description> <maml:para>Specifies the timeout in seconds for the connection between the Trust Authority key provider and the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Specifies the description of the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerAddress</maml:name> <maml:Description> <maml:para>Specifies the first KMIP server address in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerName</maml:name> <maml:Description> <maml:para>Specifies the name of the first KMIP server in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerPassword</maml:name> <maml:Description> <maml:para>Specifies the password of the first KMIP server in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerPort</maml:name> <maml:Description> <maml:para>Specifies the port number of the first KMIP server in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerUsername</maml:name> <maml:Description> <maml:para>Specifies the user name of the first KMIP server in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MasterKeyId</maml:name> <maml:Description> <maml:para>This parameter is deprecated and scheduled for removal. Use the PrimaryKeyId parameter instead.</maml:para> <maml:para>Specifies the primary key ID of the Trust Authority key provider that you want to use from the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyAddress</maml:name> <maml:Description> <maml:para>Specifies the proxy address of the Trust Authority key provider that you want to use to connect to the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyPort</maml:name> <maml:Description> <maml:para>Specifies the proxy port number of the Trust Authority key provider that you use to connect to the KMIP servers. It works with the ProxyAddress parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-TrustAuthorityKeyProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionTimeOutSeconds</maml:name> <maml:Description> <maml:para>Specifies the timeout in seconds for the connection between the Trust Authority key provider and the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Specifies the description of the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerAddress</maml:name> <maml:Description> <maml:para>Specifies the first KMIP server address in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerName</maml:name> <maml:Description> <maml:para>Specifies the name of the first KMIP server in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerPassword</maml:name> <maml:Description> <maml:para>Specifies the password of the first KMIP server in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerPort</maml:name> <maml:Description> <maml:para>Specifies the port number of the first KMIP server in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerUsername</maml:name> <maml:Description> <maml:para>Specifies the user name of the first KMIP server in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyAddress</maml:name> <maml:Description> <maml:para>Specifies the proxy address of the Trust Authority key provider that you want to use to connect to the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyPort</maml:name> <maml:Description> <maml:para>Specifies the proxy port number of the Trust Authority key provider that you use to connect to the KMIP servers. It works with the ProxyAddress parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrimaryKeyId</maml:name> <maml:Description> <maml:para>Specifies the primary key ID of the Trust Authority key provider that you want to use from the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionTimeOutSeconds</maml:name> <maml:Description> <maml:para>Specifies the timeout in seconds for the connection between the Trust Authority key provider and the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Specifies the description of the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerAddress</maml:name> <maml:Description> <maml:para>Specifies the first KMIP server address in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerName</maml:name> <maml:Description> <maml:para>Specifies the name of the first KMIP server in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerPassword</maml:name> <maml:Description> <maml:para>Specifies the password of the first KMIP server in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerPort</maml:name> <maml:Description> <maml:para>Specifies the port number of the first KMIP server in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerUsername</maml:name> <maml:Description> <maml:para>Specifies the user name of the first KMIP server in the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MasterKeyId</maml:name> <maml:Description> <maml:para>This parameter is deprecated and scheduled for removal. Use the PrimaryKeyId parameter instead.</maml:para> <maml:para>Specifies the primary key ID of the Trust Authority key provider that you want to use from the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyAddress</maml:name> <maml:Description> <maml:para>Specifies the proxy address of the Trust Authority key provider that you want to use to connect to the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyPort</maml:name> <maml:Description> <maml:para>Specifies the proxy port number of the Trust Authority key provider that you use to connect to the KMIP servers. It works with the ProxyAddress parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrimaryKeyId</maml:name> <maml:Description> <maml:para>Specifies the primary key ID of the Trust Authority key provider that you want to use from the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-TrustAuthorityKeyProvider -TrustAuthorityCluster mycluster -Name mykp -PrimaryKeyId 1 -KmipServerAddress 1.1.1.1</dev:code> <dev:remarks> <maml:para>Creates a new Trust Authority key provider in the Trust Authority cluster mycluster with the mykp and primarykeyId 1 names for all the Key Management Interoperability Protocol (KMIP) servers in this key provider. Adds KMIP server with the 1.1.1.1 address to the key provider.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-TrustAuthorityKeyProvider.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-TrustAuthorityKeyProviderClientCertificate</command:name> <command:verb>New</command:verb> <command:noun>TrustAuthorityKeyProviderClientCertificate</command:noun> <maml:description> <maml:para>This cmdlet creates a client certificate for the specified Trust Authority key provider in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a client certificate for the specified Trust Authority key provider in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-TrustAuthorityKeyProviderClientCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider for which you want to generate a client certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider for which you want to generate a client certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Security.Cryptography.X509Certificates.X509Certificate2</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-TrustAuthorityKeyProviderClientCertificate -KeyProvider mykp</dev:code> <dev:remarks> <maml:para>Creates the client certificate for the Trust Authority key provider mykp.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-TrustAuthorityKeyProviderClientCertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderClientCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-TrustAuthorityKeyProviderClientCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TrustAuthorityKeyProviderClientCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-TrustAuthorityKeyProviderClientCertificateCSR</command:name> <command:verb>New</command:verb> <command:noun>TrustAuthorityKeyProviderClientCertificateCSR</command:noun> <maml:description> <maml:para>This cmdlet creates the client certificate Certificate Signing Request (CSR) for the specified Trust Authority key providers in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates the client certificate Certificate Signing Request (CSR) for the specified Trust Authority key providers in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-TrustAuthorityKeyProviderClientCertificateCSR</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider for which you want to generate the client certificate CSR.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider for which you want to generate the client certificate CSR.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-TrustAuthorityKeyProviderClientCertificateCSR -KeyProvider mykp</dev:code> <dev:remarks> <maml:para>Creates the client certificate CSR for the Trust Authority key provider mykp.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-TrustAuthorityKeyProviderClientCertificateCSR.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderClientCertificateCSR</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-TrustAuthorityPrincipal</command:name> <command:verb>New</command:verb> <command:noun>TrustAuthorityPrincipal</command:noun> <maml:description> <maml:para>This cmdlet creates a new Trust Authority principal in the specified Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new Trust Authority principal in the specified Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-TrustAuthorityPrincipal</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create the Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateChain</maml:name> <maml:Description> <maml:para>Specifies the certificate chain of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Chain[]</command:parameterValue> <dev:type> <maml:name>X509Chain[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Domain</maml:name> <maml:Description> <maml:para>Specifies the domain of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Issuer</maml:name> <maml:Description> <maml:para>Specifies the issuer of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">STS_USER</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">STS_GROUP</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PrincipalType</command:parameterValue> <dev:type> <maml:name>PrincipalType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-TrustAuthorityPrincipal</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create the Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the file including the trusted principal in the workload vCenter Server system to create the Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-TrustAuthorityPrincipal</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create the Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>TrustedPrincipal</maml:name> <maml:Description> <maml:para>Specifies the trusted principal in the workload vCenter Server system to create a Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedPrincipal</command:parameterValue> <dev:type> <maml:name>TrustedPrincipal</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateChain</maml:name> <maml:Description> <maml:para>Specifies the certificate chain of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Chain[]</command:parameterValue> <dev:type> <maml:name>X509Chain[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Domain</maml:name> <maml:Description> <maml:para>Specifies the domain of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the file including the trusted principal in the workload vCenter Server system to create the Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Issuer</maml:name> <maml:Description> <maml:para>Specifies the issuer of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create the Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>TrustedPrincipal</maml:name> <maml:Description> <maml:para>Specifies the trusted principal in the workload vCenter Server system to create a Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedPrincipal</command:parameterValue> <dev:type> <maml:name>TrustedPrincipal</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PrincipalType</command:parameterValue> <dev:type> <maml:name>PrincipalType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustedPrincipal</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityPrincipal</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$trustedPrincipal = Get-TrustedPrincipal -Server workloadSystem New-TrustAuthorityPrincipal -TrustAuthorityCluster mycluster -TrustedPrincipal $trustedPrincipal -Server trustAuthoritySystem</dev:code> <dev:remarks> <maml:para>Creates the Trust Authority principal in the Trust Authority cluster mycluster from the trusted principal object $trustedPrincipal. You can retrieve the trusted principal object from the connected workload vCenter Server system workloadSystem.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Export-TrustedPrincipal -Server workloadSystem -FilePath c:\mypath New-TrustAuthorityPrincipal -TrustAuthorityCluster mycluster -FilePath c:\mypath -Server trustAuthoritySystem</dev:code> <dev:remarks> <maml:para>Exports the trusted principal object from the connected workload vCenter Server system workloadSystem to the c:\mypath file. Creates the Trust Authority principal in the Trust Authority cluster mycluster from the c:\mypath file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$trustedPrincipal = Get-TrustedPrincipal -Server workloadSystem New-TrustAuthorityPrincipal -TrustAuthorityCluster mycluster -Name $trustedPrincipal.Name -Domain $trustedPrincipal.Domain -Issuer $trustedPrincipal.Issuer -CertificateChain $trustedPrincipal.CertificateChain -Type $trustedPrincipal.Type -Server trustAuthoritySystem</dev:code> <dev:remarks> <maml:para>Creates a Trust Authority principal in the Trust Authority cluster mycluster from each property of the trusted principal object. You can retrieve the Trusted principal object from the connected workload vCenter Server system workloadSystem.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-TrustAuthorityPrincipal.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-TrustedPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-TrustAuthorityTpm2CACertificate</command:name> <command:verb>New</command:verb> <command:noun>TrustAuthorityTpm2CACertificate</command:noun> <maml:description> <maml:para>This cmdlet creates a new Trust Authority TPM 2.0 Certificate Authority (CA) certificate in the specified Trust Authority Cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new Trust Authority TPM 2.0 CA certificate in the specified Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-TrustAuthorityTpm2CACertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create a new Trust Authority TPM 2.0 CA certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateChain</maml:name> <maml:Description> <maml:para>Specifies the TPM 2.0 chip's CA certificate chain that you want to use to create a Trust Authority TPM 2.0 CA certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Chain</command:parameterValue> <dev:type> <maml:name>X509Chain</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Trust Authority TPM 2.0 CA certificate that you want to create. If it's not specified, the name is the subject key identifier of the certificate which is the leaf-most certificate in the certificate chain.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-TrustAuthorityTpm2CACertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create a new Trust Authority TPM 2.0 CA certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the file where you can find the CA certificates. The file can be in a .crt or .zip format. If the file is in a .zip format, you should name the .crt files in the .zip package as <file>-00.crt, <file>-01.crt... <file>-09.crt. Use the Export-Tpm2CACertificate cmdlet to download the CA certificates from the given TPM 2.0 chip's certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Trust Authority TPM 2.0 CA certificate that you want to create. If it's not specified, the name is the subject key identifier of the certificate which is the leaf-most certificate in the certificate chain.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateChain</maml:name> <maml:Description> <maml:para>Specifies the TPM 2.0 chip's CA certificate chain that you want to use to create a Trust Authority TPM 2.0 CA certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Chain</command:parameterValue> <dev:type> <maml:name>X509Chain</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the file where you can find the CA certificates. The file can be in a .crt or .zip format. If the file is in a .zip format, you should name the .crt files in the .zip package as <file>-00.crt, <file>-01.crt... <file>-09.crt. Use the Export-Tpm2CACertificate cmdlet to download the CA certificates from the given TPM 2.0 chip's certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Trust Authority TPM 2.0 CA certificate that you want to create. If it's not specified, the name is the subject key identifier of the certificate which is the leaf-most certificate in the certificate chain.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create a new Trust Authority TPM 2.0 CA certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityTpm2CACertificate</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-TrustAuthorityTpm2CACertificate -TrustAuthorityCluster mycluster -CertificateChain $x509chain</dev:code> <dev:remarks> <maml:para>Creates a new Trust Authority TPM 2.0 CA certificate in the Trust Authority cluster mycluster from the given $x509Chain certificate chain.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-TrustAuthorityTpm2CACertificate -TrustAuthorityCluster mycluster -FilePath c:\mypath</dev:code> <dev:remarks> <maml:para>Creates a new Trust Authority TPM 2.0 CA certificate in the Trust Authority cluster mycluster from the specified c:\mypath file. The file can be in a .crt or .zip format.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-TrustAuthorityTpm2CACertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-Tpm2CACertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityTpm2CACertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityTpm2CACertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-TrustAuthorityTpm2EndorsementKey</command:name> <command:verb>New</command:verb> <command:noun>TrustAuthorityTpm2EndorsementKey</command:noun> <maml:description> <maml:para>This cmdlet creates a new Trust Authority TPM 2.0 endorsement key in the specified Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new Trust Authority TPM 2.0 endorsement key in the specified Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-TrustAuthorityTpm2EndorsementKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create a new Trust Authority TPM 2.0 endorsementKey object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Specifies the certificate of the TPM 2.0 device from a workload virtual machine host server that you want to use to create a Trust Authority TPM 2.0 endorsement key object in Trust Autority vCenter Server system.</maml:para> <maml:para>If both the Certificate and PublicKey parameters are specified, the Certificate parameter is first validated with the preconfigured CA certificates. Then the PublicKey parameter is validated with the Certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFile</maml:name> <maml:Description> <maml:para>Specifies the certificate file where you can find the TPM 2.0 device's certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the new Trust Authority TPM 2.0 endorsement key that you want to create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublicKey</maml:name> <maml:Description> <maml:para>Specifies the TPM 2.0 device's public key in PEM format.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublicKeyFile</maml:name> <maml:Description> <maml:para>Specifies the file where you can find the TPM 2.0 device's public key.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-TrustAuthorityTpm2EndorsementKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create a new Trust Authority TPM 2.0 endorsementKey object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the file where you can find the TPM 2.0 endorsement key.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-TrustAuthorityTpm2EndorsementKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create a new Trust Authority TPM 2.0 endorsementKey object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tpm2EndorsementKey</maml:name> <maml:Description> <maml:para>Specifies the TPM 2.0 endorsement key of the TPM 2.0 device from a workload virtual machine host server that you can use to create Trust Authority TPM 2.0 endorsement key object in the Trust Autority vCenter Server system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Tpm2EndorsementKey[]</command:parameterValue> <dev:type> <maml:name>Tpm2EndorsementKey[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Specifies the certificate of the TPM 2.0 device from a workload virtual machine host server that you want to use to create a Trust Authority TPM 2.0 endorsement key object in Trust Autority vCenter Server system.</maml:para> <maml:para>If both the Certificate and PublicKey parameters are specified, the Certificate parameter is first validated with the preconfigured CA certificates. Then the PublicKey parameter is validated with the Certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateFile</maml:name> <maml:Description> <maml:para>Specifies the certificate file where you can find the TPM 2.0 device's certificate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the file where you can find the TPM 2.0 endorsement key.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the new Trust Authority TPM 2.0 endorsement key that you want to create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublicKey</maml:name> <maml:Description> <maml:para>Specifies the TPM 2.0 device's public key in PEM format.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublicKeyFile</maml:name> <maml:Description> <maml:para>Specifies the file where you can find the TPM 2.0 device's public key.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tpm2EndorsementKey</maml:name> <maml:Description> <maml:para>Specifies the TPM 2.0 endorsement key of the TPM 2.0 device from a workload virtual machine host server that you can use to create Trust Authority TPM 2.0 endorsement key object in the Trust Autority vCenter Server system.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Tpm2EndorsementKey[]</command:parameterValue> <dev:type> <maml:name>Tpm2EndorsementKey[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you want to create a new Trust Authority TPM 2.0 endorsementKey object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.Tpm2EndorsementKey[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityTpm2EndorsementKey</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-VIServer -Server 1.1.1.1 -User root -Password mypasswd $tpm2Ek = Get-Tpm2EndorsementKey -Server 1.1.1.1 -VMHost 1.1.1.1 New-TrustAuthorityTpm2EndorsementKey -TrustAuthorityCluster mycluster -Tpm2EndorsementKey $tpm2Ek -Server trustAuthoritySystem</dev:code> <dev:remarks> <maml:para>Creates a Trust Authority TPM 2.0 endorsement key in the Trust Authority cluster mycluster from the TPM 2.0 endorsement key object $tpm2Ek. You can retrieve the TPM 2.0 endorsement key object from the connected workload virtual machine host server 1.1.1.1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Connect-VIServer -Server 1.1.1.1 -User root -Password mypasswd Export-Tpm2EndorsementKey -Server 1.1.1.1 -FilePath c:\mypath -VMHost 1.1.1.1 New-TrustAuthorityTpm2EndorsementKey -TrustAuthorityCluster mycluster -FilePath c:\mypath -Server trustAuthoritySystem</dev:code> <dev:remarks> <maml:para>Creates a Trust Authority TPM 2.0 endorsement key in the Trust Authority cluster mycluster from the c:\mypath file. You can export the TPM 2.0 endorsement key object from the connected workload virtual machine host server 1.1.1.1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Connect-VIServer -Server 1.1.1.1 -User root -Password mypasswd $tpm2Ek = Get-Tpm2EndorsementKey -Server 1.1.1.1 -VMHost 1.1.1.1 New-TrustAuthorityTpm2EndorsementKey -TrustAuthorityCluster mycluster -Name mytpm2Ek -Certificate $tpm2Ek.Certificate -PublicKey $tpm2Ek.PublicKey -Server trustAuthoritySystem</dev:code> <dev:remarks> <maml:para>Creates a Trust Authority TPM 2.0 endorsement key with the mytpm2Ek name in the Trust Authority cluster mycluster from each property of the Tpm2EndorsementKey object. You can retrieve the TPM 2.0 endorsement key object from the connected workload virtual machine host server 1.1.1.1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-TrustAuthorityTpm2EndorsementKey.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-Tpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityTpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityTpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-TrustAuthorityVMHostBaseImage</command:name> <command:verb>New</command:verb> <command:noun>TrustAuthorityVMHostBaseImage</command:noun> <maml:description> <maml:para>This cmdlet creates a Trust Authority virtual machine host base image in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a Trust Authority virtual machine host base image in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-TrustAuthorityVMHostBaseImage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you can create a new Trust Authority virtual machine host base image.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the image file that you can use to create a Trust Authority virtual machine host base image. The file is in a .tgz format.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:Description> <maml:para>Specifies the image file that you can use to create a Trust Authority virtual machine host base image. The file is in a .tgz format.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster in which you can create a new Trust Authority virtual machine host base image.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityVMHostBaseImage</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Export-VMHostImageDb -VMHost 1.1.1.1 -FilePath c:\mypath -Server workloadSystem New-TrustAuthorityVMHostBaseImage -TrustAuthorityCluster mycluster -FilePath c:\mypath -Server trustAuthoritySystem</dev:code> <dev:remarks> <maml:para>Creates a new Trust Authority virtual machine host base image in the Trust Authority cluster mycluster from the image file c:\mypath. You can export it from a workload host in the workload vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-TrustAuthorityVMHostBaseImage.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-VMHostImageDb</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityVMHostBaseImage</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityVMHostBaseImage</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-VTpm</command:name> <command:verb>New</command:verb> <command:noun>VTpm</command:noun> <maml:description> <maml:para>This cmdlet creates a new vTPM device on the specified virtual machine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new vTPM device on the specified virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VTpm</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VM</maml:name> <maml:Description> <maml:para>Specifies the virtual machine to which you want to add the vTPM device.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> <dev:type> <maml:name>VirtualMachine</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VM</maml:name> <maml:Description> <maml:para>Specifies the virtual machine to which you want to add the vTPM device.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> <dev:type> <maml:name>VirtualMachine</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.ViCore.Types.V1.Inventory.VirtualMachine</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.Entity.VTpm</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Works only on vCenter Server system versions 6.7 or later and ESX versions 6.7 or later. If the given virtual machine is not encrypted with its virtual machine home, it is required to place the default KMS cluster in the vCenter Server system. As a result of this operation, the virtual machine home of the given virtual machine is encrypted.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VM MyVM | New-VTpm</dev:code> <dev:remarks> <maml:para>Adds a new vTPM device to the virtual machine named "MyVM".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-VTpm.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpmCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpmCSR</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-KeyProvider</command:name> <command:verb>Register</command:verb> <command:noun>KeyProvider</command:noun> <maml:description> <maml:para>This cmdlet registers a trusted key provider in the workload vCenter Server system which you can use for encryption operations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet registers a trusted key provider in the workload vCenter Server system which you can use for encryption operations.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-KeyProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the key provider that you want to register. If the given key provider's type is KeyProvider, the cmdlet fails.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">KmsCluster[]</command:parameterValue> <dev:type> <maml:name>KmsCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the key provider that you want to register. If the given key provider's type is KeyProvider, the cmdlet fails.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">KmsCluster[]</command:parameterValue> <dev:type> <maml:name>KmsCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.ViCore.Types.V1.Security.KmsCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.ViCore.Types.V1.Security.KeyProvider</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$kp = Get-KeyProvider | Where-Object {$_.Type -eq 'TrustedKeyProvider'} Register-KeyProvider -KeyProvider $kp</dev:code> <dev:remarks> <maml:para>Registers all trusted key providers in the connected workload vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Register-KeyProvider.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-KeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AttestationServiceInfo</command:name> <command:verb>Remove</command:verb> <command:noun>AttestationServiceInfo</command:noun> <maml:description> <maml:para>This cmdlet removes the specified attestation services information from the workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the specified attestation services information from the workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AttestationServiceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AttestationServiceInfo</maml:name> <maml:Description> <maml:para>Specifies the attestation services information you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AttestationServiceInfo[]</command:parameterValue> <dev:type> <maml:name>AttestationServiceInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>AttestationServiceInfo</maml:name> <maml:Description> <maml:para>Specifies the attestation services information you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AttestationServiceInfo[]</command:parameterValue> <dev:type> <maml:name>AttestationServiceInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.AttestationServiceInfo[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$attest = Get-AttestationServiceInfo Remove-AttestationServiceInfo -AttestationServiceInfo $attest</dev:code> <dev:remarks> <maml:para>Removes the attestation services information configured in the connected workload vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-AttestationServiceInfo.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustedClusterAttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustedClusterAttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-KeyProviderServiceInfo</command:name> <command:verb>Remove</command:verb> <command:noun>KeyProviderServiceInfo</command:noun> <maml:description> <maml:para>This cmdlet removes the specified key provider services information from the workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the specified key provider services information from the workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-KeyProviderServiceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>KeyProviderServiceInfo</maml:name> <maml:Description> <maml:para>Specifies the key provider services information that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">KeyProviderServiceInfo[]</command:parameterValue> <dev:type> <maml:name>KeyProviderServiceInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>KeyProviderServiceInfo</maml:name> <maml:Description> <maml:para>Specifies the key provider services information that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">KeyProviderServiceInfo[]</command:parameterValue> <dev:type> <maml:name>KeyProviderServiceInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.KeyProviderServiceInfo[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$kmxd = Get-KeyProviderServiceInfo Remove-KeyProviderServiceInfo -KeyProviderServiceInfo $kmxd</dev:code> <dev:remarks> <maml:para>Removes the key provider services information configured in the connected workload vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-KeyProviderServiceInfo.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-KeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-KeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustedClusterKeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustedClusterKeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TrustAuthorityKeyProvider</command:name> <command:verb>Remove</command:verb> <command:noun>TrustAuthorityKeyProvider</command:noun> <maml:description> <maml:para>This cmdlet removes the specified Trust Authority key providers from the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the specified Trust Authority key providers from the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TrustAuthorityKeyProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-TrustAuthorityKeyProvider -KeyProvider mykp</dev:code> <dev:remarks> <maml:para>Removes the Trust Authority key provider mykp from the connected Trust Authority vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-TrustAuthorityKeyProvider.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TrustAuthorityKeyProviderServer</command:name> <command:verb>Remove</command:verb> <command:noun>TrustAuthorityKeyProviderServer</command:noun> <maml:description> <maml:para>This cmdlet removes the specified Trust Authority key provider servers from their location in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the specified Trust Authority key provider servers from their location in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TrustAuthorityKeyProviderServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>KeyProviderServer</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider servers that you want to remove. You cannot remove all Trust Authority key provider servers from a Trust Authority key provider. A Trust Authority key provider requires at least 1 Trust Authority key provider server.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProviderServer[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProviderServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>KeyProviderServer</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider servers that you want to remove. You cannot remove all Trust Authority key provider servers from a Trust Authority key provider. A Trust Authority key provider requires at least 1 Trust Authority key provider server.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProviderServer[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProviderServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProviderServer[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$kmipServer = Get-TrustAuthorityKeyProviderServer -KeyProvider mykp | select -Last 1 Remove-TrustAuthorityKeyProviderServer -KeyProviderServer $kmipServer</dev:code> <dev:remarks> <maml:para>Removes the last Trust Authority key provider server from the mykp Trust Authority key provider.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-TrustAuthorityKeyProviderServer.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustAuthorityKeyProviderServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TrustAuthorityKeyProviderServerCertificate</command:name> <command:verb>Remove</command:verb> <command:noun>TrustAuthorityKeyProviderServerCertificate</command:noun> <maml:description> <maml:para>This cmdlet removes the specified Trust Authority key provider server certificates from their location. The certificate is no longer trusted by the Trust Authority key provider in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the specified Trust Authority key provider server certificates from their location. The certificate is no longer trusted by the Trust Authority key provider in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TrustAuthorityKeyProviderServerCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>ServerCertificate</maml:name> <maml:Description> <maml:para>Specifies the server certificates that you no longer want to be trusted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProviderServerCertificate[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProviderServerCertificate[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>ServerCertificate</maml:name> <maml:Description> <maml:para>Specifies the server certificates that you no longer want to be trusted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProviderServerCertificate[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProviderServerCertificate[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProviderServerCertificate[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$servercert = Get-TrustAuthorityKeyProviderServerCertificate -KeyProvider mykp | select -First 1 Remove-TrustAuthorityKeyProviderServerCertificate -ServerCertificate $servercert</dev:code> <dev:remarks> <maml:para>Removes the first trusted server certificate from the mykp Trust Authority key provider.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-TrustAuthorityKeyProviderServerCertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustAuthorityKeyProviderServerCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderServerCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TrustAuthorityPrincipal</command:name> <command:verb>Remove</command:verb> <command:noun>TrustAuthorityPrincipal</command:noun> <maml:description> <maml:para>This cmdlet removes the Trust Authority principals from their location in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the Trust Authority principals from their location in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TrustAuthorityPrincipal</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Principal"> <maml:name>TrustAuthorityPrincipal</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority principals that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityPrincipal[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityPrincipal[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Principal"> <maml:name>TrustAuthorityPrincipal</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority principals that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityPrincipal[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityPrincipal[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityPrincipal[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$principals = Get-TrustAuthorityPrincipal -TrustAuthorityCluster mycluster Remove-TrustAuthorityPrincipal -TrustAuthorityPrincipal $principals</dev:code> <dev:remarks> <maml:para>Removes the Trust Authority principals from the mycluster Trust Authority cluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-TrustAuthorityPrincipal.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityPrincipal</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TrustAuthorityTpm2CACertificate</command:name> <command:verb>Remove</command:verb> <command:noun>TrustAuthorityTpm2CACertificate</command:noun> <maml:description> <maml:para>This cmdlet removes the Trust Authority TPM 2.0 certificate authority (CA) certificates from the Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the Trust Authority TPM 2.0 certificate authority (CA) certificates from the Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TrustAuthorityTpm2CACertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Tpm2CACertificate</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority TPM 2.0 CA certificates that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityTpm2CACertificate[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityTpm2CACertificate[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Tpm2CACertificate</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority TPM 2.0 CA certificates that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityTpm2CACertificate[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityTpm2CACertificate[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityTpm2CACertificate[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$cacerts = Get-TrustAuthorityTpm2CACertificate -TrustAuthorityCluster mycluster Remove-TrustAuthorityTpm2CACertificate -Tpm2CACertificate $cacerts</dev:code> <dev:remarks> <maml:para>Removes the Trust Authority TPM 2.0 CA certificates from the mycluster Trust Authority cluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-TrustAuthorityTpm2CACertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityTpm2CACertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityTpm2CACertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TrustAuthorityTpm2EndorsementKey</command:name> <command:verb>Remove</command:verb> <command:noun>TrustAuthorityTpm2EndorsementKey</command:noun> <maml:description> <maml:para>This cmdlet removes the Trust Authority TPM 2.0 endorsement keys from the Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the Trust Authority TPM 2.0 endorsement keys from the Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TrustAuthorityTpm2EndorsementKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Tpm2EndorsementKey</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority TPM 2.0 endorsement keys that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityTpm2EndorsementKey[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityTpm2EndorsementKey[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Tpm2EndorsementKey</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority TPM 2.0 endorsement keys that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityTpm2EndorsementKey[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityTpm2EndorsementKey[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityTpm2EndorsementKey[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$tpm2Eks = Get-TrustAuthorityTpm2EndorsementKey -TrustAuthorityCluster mycluster Remove-TrustAuthorityTpm2EndorsementKey -Tpm2EndorsementKey $tpm2Eks</dev:code> <dev:remarks> <maml:para>Removes the Trust Authority TPM 2.0 endorsement keys from the Trust Authority cluster mycluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-TrustAuthorityTpm2EndorsementKey.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityTpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityTpm2EndorsementKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TrustAuthorityVMHostBaseImage</command:name> <command:verb>Remove</command:verb> <command:noun>TrustAuthorityVMHostBaseImage</command:noun> <maml:description> <maml:para>This cmdlet removes the Trust Authority virtual machine host base images from the Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the Trust Authority virtual machine host base images from the Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TrustAuthorityVMHostBaseImage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VMHostBaseImage</maml:name> <maml:Description> <maml:para>Specifies the virtual machine host base images that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityVMHostBaseImage[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityVMHostBaseImage[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VMHostBaseImage</maml:name> <maml:Description> <maml:para>Specifies the virtual machine host base images that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityVMHostBaseImage[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityVMHostBaseImage[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityVMHostBaseImage[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$baseImages = Get-TrustAuthorityVMHostBaseImage -TrustAuthorityCluster mycluster Remove-TrustAuthorityVMHostBaseImage -VMHostBaseImage $baseImages</dev:code> <dev:remarks> <maml:para>Removes the Trust Authority virtual machine host base images from the mycluster Trust Authority cluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-TrustAuthorityVMHostBaseImage.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityVMHostBaseImage</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityVMHostBaseImage</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TrustedClusterAttestationServiceInfo</command:name> <command:verb>Remove</command:verb> <command:noun>TrustedClusterAttestationServiceInfo</command:noun> <maml:description> <maml:para>This cmdlet removes the attestation services information from the specified trusted cluster in the workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the attestation services information from the specified trusted cluster in the workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TrustedClusterAttestationServiceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustedCluster</maml:name> <maml:Description> <maml:para>Specifies the trusted cluster from which you want to remove the attestation service information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCluster</command:parameterValue> <dev:type> <maml:name>TrustedCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>AttestationServiceInfo</maml:name> <maml:Description> <maml:para>Specifies the attestation services information that you want to remove from the specified trusted cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AttestationServiceInfo[]</command:parameterValue> <dev:type> <maml:name>AttestationServiceInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>AttestationServiceInfo</maml:name> <maml:Description> <maml:para>Specifies the attestation services information that you want to remove from the specified trusted cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AttestationServiceInfo[]</command:parameterValue> <dev:type> <maml:name>AttestationServiceInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustedCluster</maml:name> <maml:Description> <maml:para>Specifies the trusted cluster from which you want to remove the attestation service information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCluster</command:parameterValue> <dev:type> <maml:name>TrustedCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustedCluster</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>When working with vCenter Server 7.0 Update 1 and later, this cmdlet might leave the trusted clusters unhealthy in the TrustedClusterAppliedStatus. For example, if the trusted clusters are already unhealthy in the TrustedClusterAppliedStatus, this operation does not change the healthy status of the trusted clusters. Use the Set-TrustedCluster cmdlet to remediate it afterwards.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$cluster = Get-TrustedCluster mycluster Remove-TrustedClusterAttestationServiceInfo -TrustedCluster mycluster -AttestationServiceInfo $cluster.AttestationServiceInfo</dev:code> <dev:remarks> <maml:para>Removes the attestation services information configured in the trusted mycluster cluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-TrustedClusterAttestationServiceInfo.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustedClusterAttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedClusterAppliedStatus</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TrustedClusterKeyProviderServiceInfo</command:name> <command:verb>Remove</command:verb> <command:noun>TrustedClusterKeyProviderServiceInfo</command:noun> <maml:description> <maml:para>This cmdlet removes the key provider services information from the specified trusted cluster in the workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the key provider services information from the specified trusted cluster in the workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TrustedClusterKeyProviderServiceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustedCluster</maml:name> <maml:Description> <maml:para>Specifies the trusted cluster from which you want to remove the key provider service information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCluster</command:parameterValue> <dev:type> <maml:name>TrustedCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>KeyProviderServiceInfo</maml:name> <maml:Description> <maml:para>Specifies the key provider services information you want to remove from the specified trusted cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">KeyProviderServiceInfo[]</command:parameterValue> <dev:type> <maml:name>KeyProviderServiceInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>KeyProviderServiceInfo</maml:name> <maml:Description> <maml:para>Specifies the key provider services information you want to remove from the specified trusted cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">KeyProviderServiceInfo[]</command:parameterValue> <dev:type> <maml:name>KeyProviderServiceInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustedCluster</maml:name> <maml:Description> <maml:para>Specifies the trusted cluster from which you want to remove the key provider service information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCluster</command:parameterValue> <dev:type> <maml:name>TrustedCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustedCluster</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>When working with vCenter Server 7.0 Update 1 and later, this cmdlet might leave the trusted clusters unhealthy in the TrustedClusterAppliedStatus. For example, if the trusted clusters are already unhealthy in the TrustedClusterAppliedStatus, this operation does not change the healthy status of the trusted clusters. Use the Set-TrustedCluster cmdlet to remediate it afterwards.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$cluster = Get-TrustedCluster mycluster Remove-TrustedClusterKeyProviderServiceInfo -TrustedCluster mycluster -KeyProviderServiceInfo $cluster.KeyProviderServiceInfo</dev:code> <dev:remarks> <maml:para>Removes the key provider services information configured in the trusted mycluster cluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-TrustedClusterKeyProviderServiceInfo.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustedClusterKeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedClusterAppliedStatus</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VTpm</command:name> <command:verb>Remove</command:verb> <command:noun>VTpm</command:noun> <maml:description> <maml:para>This cmdlet removes the specified vTPM devices.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the specified vTPM devices.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VTpm</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VTpm</maml:name> <maml:Description> <maml:para>Specifies the vTPM devices that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VTpm[]</command:parameterValue> <dev:type> <maml:name>VTpm[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are removed.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running; if the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are removed.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running; if the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VTpm</maml:name> <maml:Description> <maml:para>Specifies the vTPM devices that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VTpm[]</command:parameterValue> <dev:type> <maml:name>VTpm[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.Entity.VTpm[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$myVm = Get-VM MyVM Get-VTpm -VM $myVm | Remove-VTpm</dev:code> <dev:remarks> <maml:para>Removes the vTPM device from the virtual machine named 'MyVM'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$vtpm = Get-VTpm -VM "MyVM" Remove-VTpm -VTpm $vtpm</dev:code> <dev:remarks> <maml:para>Removes the vTPM device from the virtual machine named "MyVM".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-VTpm.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpmCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpmCSR</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TrustAuthorityCluster</command:name> <command:verb>Set</command:verb> <command:noun>TrustAuthorityCluster</command:noun> <maml:description> <maml:para>This cmdlet modifies the configuration of the specified Trust Authority clusters in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet modifies the configuration of the specified Trust Authority clusters in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TrustAuthorityCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>State</maml:name> <maml:Description> <maml:para>Specifies the state in which you want to modify the specified Trust Authority clusters.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">TrustAuthorityState</command:parameterValue> <dev:type> <maml:name>TrustAuthorityState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>State</maml:name> <maml:Description> <maml:para>Specifies the state in which you want to modify the specified Trust Authority clusters.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityState</command:parameterValue> <dev:type> <maml:name>TrustAuthorityState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority clusters that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityCluster</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-TrustAuthorityCluster -TrustAuthorityCluster mycluster -State Enabled</dev:code> <dev:remarks> <maml:para>Enables the Trust Authority cluster mycluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-TrustAuthorityCluster.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TrustAuthorityKeyProvider</command:name> <command:verb>Set</command:verb> <command:noun>TrustAuthorityKeyProvider</command:noun> <maml:description> <maml:para>This cmdlet modifies the Trust Authority key providers with the specified properties in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet modifies the Trust Authority key providers with the specified properties in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TrustAuthorityKeyProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionTimeoutSeconds</maml:name> <maml:Description> <maml:para>Specifies the timeout in seconds of the connection between the Trust Authority key provider and the Trust Authority key provider server.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Specifies the description you want to set to the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerUsername</maml:name> <maml:Description> <maml:para>Specifies the new user name that you can use to connect to the KMIP servers from the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MasterKeyId</maml:name> <maml:Description> <maml:para>This parameter is deprecated and scheduled for removal. Use the PrimaryKeyId parameter instead.</maml:para> <maml:para>Specifies the new primary key ID of the Trust Authority key provider that you want to use from the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyAddress</maml:name> <maml:Description> <maml:para>Specifies the new proxy address of the Trust Authority key provider that you can use to connect to the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyPort</maml:name> <maml:Description> <maml:para>Specifies the new porxy port number of the Trust Authority key provider that you can use to connect to the KMIP servers. This parameter works with the ProxyAddress parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the new type of the Trust Authority key provider servers.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">KMIP</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">KmsType</command:parameterValue> <dev:type> <maml:name>KmsType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrimaryKeyId</maml:name> <maml:Description> <maml:para>Specifies the new primary key ID of the Trust Authority key provider that you want to use from the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-TrustAuthorityKeyProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerPassword</maml:name> <maml:Description> <maml:para>Specifies the new password that you can use to connect to the KMIP servers from the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionTimeoutSeconds</maml:name> <maml:Description> <maml:para>Specifies the timeout in seconds of the connection between the Trust Authority key provider and the Trust Authority key provider server.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Specifies the description you want to set to the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerPassword</maml:name> <maml:Description> <maml:para>Specifies the new password that you can use to connect to the KMIP servers from the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KmipServerUsername</maml:name> <maml:Description> <maml:para>Specifies the new user name that you can use to connect to the KMIP servers from the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MasterKeyId</maml:name> <maml:Description> <maml:para>This parameter is deprecated and scheduled for removal. Use the PrimaryKeyId parameter instead.</maml:para> <maml:para>Specifies the new primary key ID of the Trust Authority key provider that you want to use from the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyAddress</maml:name> <maml:Description> <maml:para>Specifies the new proxy address of the Trust Authority key provider that you can use to connect to the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyPort</maml:name> <maml:Description> <maml:para>Specifies the new porxy port number of the Trust Authority key provider that you can use to connect to the KMIP servers. This parameter works with the ProxyAddress parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the new type of the Trust Authority key provider servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">KmsType</command:parameterValue> <dev:type> <maml:name>KmsType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrimaryKeyId</maml:name> <maml:Description> <maml:para>Specifies the new primary key ID of the Trust Authority key provider that you want to use from the KMIP servers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-TrustAuthorityKeyProvider -KeyProvider mykp -KmipServerUsername root</dev:code> <dev:remarks> <maml:para>Sets the user name of the Key Management Interoperability Protocol (KMIP) servers in the mykp Trust Authority key provider.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-TrustAuthorityKeyProvider -KeyProvider mykp -KmipServerPassword mypassword</dev:code> <dev:remarks> <maml:para>Sets the password of the KMIP servers in the mykp Trust Authority key provider.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-TrustAuthorityKeyProvider.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityKeyPrivider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityKeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TrustAuthorityKeyProviderClientCertificate</command:name> <command:verb>Set</command:verb> <command:noun>TrustAuthorityKeyProviderClientCertificate</command:noun> <maml:description> <maml:para>This cmdlet updates the client certificate of the specified Trust Authority key providers in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet updates the client certificate of the specified Trust Authority key providers in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TrustAuthorityKeyProviderClientCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Specifies the certificate that you want to update to the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrivateKey</maml:name> <maml:Description> <maml:para>Specifies the private key part of the certificate that you want to update to the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrivateKeyFilePath</maml:name> <maml:Description> <maml:para>Specifies the file with the private key part of the certificate that you want to update to the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-TrustAuthorityKeyProviderClientCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CertificateFilePath</maml:name> <maml:Description> <maml:para>Specifies the file with the certificate that you want to update to the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrivateKey</maml:name> <maml:Description> <maml:para>Specifies the private key part of the certificate that you want to update to the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrivateKeyFilePath</maml:name> <maml:Description> <maml:para>Specifies the file with the private key part of the certificate that you want to update to the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Specifies the certificate that you want to update to the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CertificateFilePath</maml:name> <maml:Description> <maml:para>Specifies the file with the certificate that you want to update to the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key providers that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider[]</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrivateKey</maml:name> <maml:Description> <maml:para>Specifies the private key part of the certificate that you want to update to the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrivateKeyFilePath</maml:name> <maml:Description> <maml:para>Specifies the file with the private key part of the certificate that you want to update to the Trust Authority key provider.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Security.Cryptography.X509Certificates.X509Certificate2</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-TrustAuthorityKeyProviderClientCertificate -KeyProvider mykp -Certificate $mycert -Privatekey $mycertKey</dev:code> <dev:remarks> <maml:para>Updates the client certificate of the Trust Authority key provider mykp with the given certificate $mycert and its private key $mycertKey.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-TrustAuthorityKeyProviderClientCertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderClientCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-TrustAuthorityKeyProviderClientCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TrustAuthorityKeyProviderServerCertificate</command:name> <command:verb>Set</command:verb> <command:noun>TrustAuthorityKeyProviderServerCertificate</command:noun> <maml:description> <maml:para>This cmdlet updates the trusted server certificates of the specified Trust Authority key providers in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet updates the trusted server certificates of the specified Trust Authority key providers in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TrustAuthorityKeyProviderServerCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Specifies the certificates that you can trust.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2[]</command:parameterValue> <dev:type> <maml:name>X509Certificate2[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Specifies the certificates that you can trust.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2[]</command:parameterValue> <dev:type> <maml:name>X509Certificate2[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Provider"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority key provider that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityKeyProvider</command:parameterValue> <dev:type> <maml:name>TrustAuthorityKeyProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where the Trust Authority key provider resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProviderServerCertificate</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $kmipServers = Get-TrustAuthorityKeyProvider -Name "myprovider" -TrustAuthorityCluster "mycluster" | Get-TrustAuthorityKeyProviderServer PS C:\> $serverCerts= Get-TrustAuthorityKeyProviderServerCertificate -KeyProviderServer $kmipServers PS C:\> Set-TrustAuthorityKeyProviderServerCertificate -KeyProvider "myprovider" -TrustAuthorityCluster "mycluster" -Certificate $serverCerts.Certificate</dev:code> <dev:remarks> <maml:para>Indicates that the Trust Authority key provider myprovider can trust the certificates of the Trust Authority key provider servers in it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-TrustAuthorityKeyProviderServerCertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustAuthorityKeyProviderServerCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityKeyProviderServerCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustAuthorityKeyProviderServerCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TrustAuthorityTpm2AttestationSettings</command:name> <command:verb>Set</command:verb> <command:noun>TrustAuthorityTpm2AttestationSettings</command:noun> <maml:description> <maml:para>This cmdlet modifies the Trust Authority TPM 2.0 attestation settings of the Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet modifies the Trust Authority TPM 2.0 attestation settings of the Trust Authority cluster in the Trust Authority vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TrustAuthorityTpm2AttestationSettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Tpm2AttestationSettings</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority TPM 2.0 attestation settings that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityTpm2AttestationSettings</command:parameterValue> <dev:type> <maml:name>TrustAuthorityTpm2AttestationSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RequireCertificateValidation</maml:name> <maml:Description> <maml:para>Updates the specified Trust Authority TPM 2.0 attestation settings to require the TPM 2.0 certificate authority (CA) certificate validation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RequireEndorsementKey</maml:name> <maml:Description> <maml:para>Updates the specified Trust Authority TPM 2.0 attestation settings to require the TPM 2.0 endorsement key validation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-TrustAuthorityTpm2AttestationSettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where you want to modify the Trust Authority TPM 2.0 attestation settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RequireCertificateValidation</maml:name> <maml:Description> <maml:para>Updates the specified Trust Authority TPM 2.0 attestation settings to require the TPM 2.0 certificate authority (CA) certificate validation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RequireEndorsementKey</maml:name> <maml:Description> <maml:para>Updates the specified Trust Authority TPM 2.0 attestation settings to require the TPM 2.0 endorsement key validation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RequireCertificateValidation</maml:name> <maml:Description> <maml:para>Updates the specified Trust Authority TPM 2.0 attestation settings to require the TPM 2.0 certificate authority (CA) certificate validation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RequireEndorsementKey</maml:name> <maml:Description> <maml:para>Updates the specified Trust Authority TPM 2.0 attestation settings to require the TPM 2.0 endorsement key validation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Tpm2AttestationSettings</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority TPM 2.0 attestation settings that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityTpm2AttestationSettings</command:parameterValue> <dev:type> <maml:name>TrustAuthorityTpm2AttestationSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustAuthorityCluster</maml:name> <maml:Description> <maml:para>Specifies the Trust Authority cluster where you want to modify the Trust Authority TPM 2.0 attestation settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustAuthorityCluster</command:parameterValue> <dev:type> <maml:name>TrustAuthorityCluster</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityTpm2AttestationSettings</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityTpm2AttestationSettings</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$tpm2Settings = Get-TrustAuthorityTpm2AttestationSettings -TrustAuthorityCluster mycluster Set-TrustAuthorityTpm2AttestationSettings -Tpm2AttestationSettings $tpm2Settings -RequireCertificateValidation -RequireEndorsementKey</dev:code> <dev:remarks> <maml:para>Modifies the Trust Authority TPM 2.0 attestation settings in the Trust Authority Cluster mycluster. The CertificateValidation and EndorsementKey parameters are required.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-TrustAuthorityTpm2AttestationSettings.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustAuthorityTpm2AttestationSettings</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TrustedCluster</command:name> <command:verb>Set</command:verb> <command:noun>TrustedCluster</command:noun> <maml:description> <maml:para>This cmdlet modifies the configuration of the trusted clusters in the workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet modifies the configuration of the trusted clusters in the workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TrustedCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustedCluster</maml:name> <maml:Description> <maml:para>Specifies the trusted clusters you want to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCluster[]</command:parameterValue> <dev:type> <maml:name>TrustedCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>State</maml:name> <maml:Description> <maml:para>Specifies the state in which you want to update the specified trusted clusters. Note: In vCenter Server 7.0 Update 1 and later, a warning message appears if the given trusted cluster is unhealthy in the TrustedClusterAppliedStatus. This cmdlet remediates it automatically.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">TrustedState</command:parameterValue> <dev:type> <maml:name>TrustedState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Remediate</maml:name> <maml:Description> <maml:para>Indicates that you want to remediate the given trusted cluster to make the applied status healthy. Note: This parameter is only available for the vCenter Server system 7.0 Update 1 and later.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>State</maml:name> <maml:Description> <maml:para>Specifies the state in which you want to update the specified trusted clusters. Note: In vCenter Server 7.0 Update 1 and later, a warning message appears if the given trusted cluster is unhealthy in the TrustedClusterAppliedStatus. This cmdlet remediates it automatically.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedState</command:parameterValue> <dev:type> <maml:name>TrustedState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Cluster"> <maml:name>TrustedCluster</maml:name> <maml:Description> <maml:para>Specifies the trusted clusters you want to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCluster[]</command:parameterValue> <dev:type> <maml:name>TrustedCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Remediate</maml:name> <maml:Description> <maml:para>Indicates that you want to remediate the given trusted cluster to make the applied status healthy. Note: This parameter is only available for the vCenter Server system 7.0 Update 1 and later.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustedCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustedCluster</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-TrustedCluster -TrustedCluster mycluster -State Enabled</dev:code> <dev:remarks> <maml:para>Copies the attestation service information and key provider service information from the workload vCenter Server system to the specified mycluster trusted cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-TrustedCluster -TrustedCluster mycluster -Remediate</dev:code> <dev:remarks> <maml:para>Remedites the mycluster trusted cluster. All trusted services on all virtual machine hosts in the mycluster trusted cluster become consistent with the desired state of the mycluster trusted cluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-TrustedCluster.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedCluster</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TrustedClusterAppliedStatus</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustedClusterAttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TrustedClusterKeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustedClusterAttestationServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TrustedClusterKeyProviderServiceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VTpm</command:name> <command:verb>Set</command:verb> <command:noun>VTpm</command:noun> <maml:description> <maml:para>This cmdlet modifies the properties of the specified vTPM device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet modifies the properties of the specified vTPM device. You can change the certificate of the specified vTPM device by specifying the new certificate in an X509Certificate2 object or in a file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VTpm</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VTpm</maml:name> <maml:Description> <maml:para>Specifies the vTPM device that you want to configure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VTpm</command:parameterValue> <dev:type> <maml:name>VTpm</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CertFilePath</maml:name> <maml:Description> <maml:para>Specifies the certificate file where the certificate string that you want to set to the specified vTPM device resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-VTpm</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VTpm</maml:name> <maml:Description> <maml:para>Specifies the vTPM device that you want to configure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VTpm</command:parameterValue> <dev:type> <maml:name>VTpm</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Specifies the certificate object that you want to set to the specified vTPM device.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CertFilePath</maml:name> <maml:Description> <maml:para>Specifies the certificate file where the certificate string that you want to set to the specified vTPM device resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Specifies the certificate object that you want to set to the specified vTPM device.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VTpm</maml:name> <maml:Description> <maml:para>Specifies the vTPM device that you want to configure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VTpm</command:parameterValue> <dev:type> <maml:name>VTpm</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.Entity.VTpm</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Security.Types.V1.Entity.VTpm</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The public key of the certificate should match the one in the certificate signing requests of the given vTPM device.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VTpm -VM 'MyVM' | Set-VTpm -CertFilePath 'C:\MyCertFile.cert'</dev:code> <dev:remarks> <maml:para>Changes the certificate of the vTPM device in a virtual machine named 'MyVM' with the new certificate in the 'C:\MyCertFile.cert' file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-VTpm.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VTpm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpmCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VTpmCSR</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unlock-VM</command:name> <command:verb>Unlock</command:verb> <command:noun>VM</command:noun> <maml:description> <maml:para>This cmdlet unlocks the specified virtual machine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet unlocks the specified virtual machine. The virtual machine should be encrypted, otherwise, this cmdlet would fail. If the virtual machine is in CryptoLocked state, this cmdlet will make the virtual machine become connected state.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unlock-VM</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VM</maml:name> <maml:Description> <maml:para>Specifies the virtual machine that you want to unlock.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VirtualMachine[]</command:parameterValue> <dev:type> <maml:name>VirtualMachine[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the connected viserver on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default viservers. For more information about default viservers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the connected viserver on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default viservers. For more information about default viservers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>VM</maml:name> <maml:Description> <maml:para>Specifies the virtual machine that you want to unlock.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VirtualMachine[]</command:parameterValue> <dev:type> <maml:name>VirtualMachine[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.ViCore.Types.V1.Inventory.VirtualMachine[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.ViCore.Types.V1.Inventory.VirtualMachine</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This cmdlet only works with a encrypted virtual machine. If the virtual machine is encrypted and in connected state, it will make vCenter Server system sync keys to ESX; If the virtual machine is encrypted and locked, it will bring the virtual machine back to connected state. This cmdlet only works with vCenter Server and ESX of versions 6.7 or later.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VM 'MyVM' | Unlock-VM</dev:code> <dev:remarks> <maml:para>Unlocks the virtual machine named 'MyVM'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-SecurityInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unregister-KeyProvider</command:name> <command:verb>Unregister</command:verb> <command:noun>KeyProvider</command:noun> <maml:description> <maml:para>This cmdlet unregisters the specified key provider from the workload vCenter Server system. For a trusted key provider, you cannot use it in encryption operations. For a standard key provider, you can remove it from the workload vCenter Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet unregisters the specified key provider from the workload vCenter Server system. For a trusted key provider, you cannot use it in encryption operations. For a standard key provider, you can remove it from the workload vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-KeyProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the key providers that you want to unregister or remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">KmsCluster[]</command:parameterValue> <dev:type> <maml:name>KmsCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>KeyProvider</maml:name> <maml:Description> <maml:para>Specifies the key providers that you want to unregister or remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">KmsCluster[]</command:parameterValue> <dev:type> <maml:name>KmsCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.ViCore.Types.V1.Security.KmsCluster[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Unregister-KeyProvider -KeyProvider mykp</dev:code> <dev:remarks> <maml:para>Unregisters the key provider mykp from the connected workload vCenter Server system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Unregister-KeyProvider.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-KeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-KeyProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |