TrustAuthority Category | Vmware PowerCLI Reference

Trust Authority Category

Cmdlets are usually implemented around resource operations. The four basic operations are CREATE, READ, UPDATE and DELETE. This set of operations is known as CRUD. Most of the cmdlets support CRUD which are respectively cmdlets that start with the New/Get/Set/Remove cmdlet verbs but they also may have additional operations

Step 1: Retrieve a object by running a Get command

You can READ objects by using Get-TrustAuthorityAttestationService cmdlet. See example below:

# Retrieves the Trust Authority attestation services from the mycluster Trust Authority cluster after you enable it.

Set-TrustAuthorityCluster -TrustAuthorityCluster mycluster -State Enabled Get-TrustAuthorityAttestationService -TrustAuthorityCluster mycluster

Step 2 : Run commands from the CRUD group

You can CREATE objects by using New-TrustAuthorityKeyProvider cmdlet. See example below:

# 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.

New-TrustAuthorityKeyProvider -TrustAuthorityCluster mycluster -Name mykp -PrimaryKeyId 1 -KmipServerAddress 1.1.1.1
You can UPDATE objects by using Add-TrustAuthorityKeyProviderServer cmdlet. See example below:

# Adds a new Trust Authority key provider server with address 1.1.1.1 to the Trust Authority key provider named myProvider.

$kp = Get-TrustAuthorityKeyProvider -Name myProvider -TrustAuthorityCluster myCluster Add-TrustAuthorityKeyProviderServer -KeyProvider $kp -Address 1.1.1.1
You can REMOVE objects by using Remove-TrustAuthorityKeyProvider cmdlet. See example below:

# Removes the Trust Authority key provider mykp from the connected Trust Authority vCenter Server system.

Remove-TrustAuthorityKeyProvider -KeyProvider mykp

Step 3: Explore More Related Commands:


Add-TrustAuthorityKeyProviderServerCertificate This cmdlet adds the certificate from the Trust Authority key provider server to be trusted by the Trust Authority key provider.
Export-TrustAuthorityKeyProviderClientCertificate This cmdlet exports the client certificate from the specified Trust Authority key provider to the specified file.
Export-TrustAuthorityServicesInfo 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.
Get-TrustAuthorityCluster This cmdlet retrieves the Trust Authority clusters from the Trust Authority vCenter Server system.
Get-TrustAuthorityKeyProvider This cmdlet retrieves the Trust Authority key providers from the specified Trust Authority cluster in the Trust Authority vCenter Server system.
Get-TrustAuthorityKeyProviderClientCertificate This cmdlet retrieves the client certificate from the specified Trust Authority key provider in the connected Trust Authority vCenter Server system.
Get-TrustAuthorityKeyProviderClientCertificateCSR 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.
Get-TrustAuthorityKeyProviderServer This cmdlet retrieves the Trust Authority key provider servers from the specified Trust Authority key providers in the connected Trust Authority vCenter Server system.
Get-TrustAuthorityKeyProviderServerCertificate 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.
Get-TrustAuthorityKeyProviderService This cmdlet retrieves the Trust Authority key provider services from the specified enabled Trust Authority cluster in the Trust Authority vCenter Server system.
Get-TrustAuthorityPrincipal This cmdlet retrieves the Trust Authority principals from the specified Trust Authority clusters in the Trust Authority vCenter Server system.
Get-TrustAuthorityServicesStatus This cmdlet retrieves the Trust Authority services status from the specified Trust Authority clusters in the connected Trust Authority vCenter Server system.
Get-TrustAuthorityTpm2AttestationSettings 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.
Get-TrustAuthorityTpm2CACertificate 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.
Get-TrustAuthorityTpm2EndorsementKey This cmdlet retrieves the Trust Authority TPM 2.0 endorsement keys from the specified Trust Authority clusters in the Trust Authority vCenter Server system.
Get-TrustAuthorityVMHostBaseImage This cmdlet retrieves the Trust Authority virtual machine host base image from the specified Trust Authority clusters in the Trust Authority vCenter Server system.
Import-TrustAuthorityServicesInfo 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.
New-TrustAuthorityKeyProviderClientCertificate This cmdlet creates a client certificate for the specified Trust Authority key provider in the Trust Authority vCenter Server system.
New-TrustAuthorityKeyProviderClientCertificateCSR This cmdlet creates the client certificate Certificate Signing Request (CSR) for the specified Trust Authority key providers in the Trust Authority vCenter Server system.
New-TrustAuthorityPrincipal This cmdlet creates a new Trust Authority principal in the specified Trust Authority cluster in the Trust Authority vCenter Server system.
New-TrustAuthorityTpm2CACertificate 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.
New-TrustAuthorityTpm2EndorsementKey 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.
New-TrustAuthorityVMHostBaseImage This cmdlet creates a Trust Authority virtual machine host base image in the Trust Authority vCenter Server system.
Remove-TrustAuthorityKeyProviderServer This cmdlet removes the specified Trust Authority key provider servers from their location in the Trust Authority vCenter Server system.
Remove-TrustAuthorityKeyProviderServerCertificate 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.
Remove-TrustAuthorityPrincipal This cmdlet removes the Trust Authority principals from their location in the Trust Authority vCenter Server system.
Remove-TrustAuthorityTpm2CACertificate 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.
Remove-TrustAuthorityTpm2EndorsementKey This cmdlet removes the Trust Authority TPM 2.0 endorsement keys from the Trust Authority cluster in the Trust Authority vCenter Server system.
Remove-TrustAuthorityVMHostBaseImage This cmdlet removes the Trust Authority virtual machine host base images from the Trust Authority cluster in the Trust Authority vCenter Server system.
Set-TrustAuthorityCluster This cmdlet modifies the configuration of the specified Trust Authority clusters in the Trust Authority vCenter Server system.
Set-TrustAuthorityKeyProvider This cmdlet modifies the Trust Authority key providers with the specified properties in the Trust Authority vCenter Server system.
Set-TrustAuthorityKeyProviderClientCertificate This cmdlet updates the client certificate of the specified Trust Authority key providers in the Trust Authority vCenter Server system.
Set-TrustAuthorityKeyProviderServerCertificate This cmdlet updates the trusted server certificates of the specified Trust Authority key providers in the Trust Authority vCenter Server system.
Set-TrustAuthorityTpm2AttestationSettings This cmdlet modifies the Trust Authority TPM 2.0 attestation settings of the Trust Authority cluster in the Trust Authority vCenter Server system.