From bbe78941862506e6fd58cd5c401b95c593ea05b8 Mon Sep 17 00:00:00 2001 From: Greg Brownstein Date: Sun, 7 Jan 2024 20:20:07 +0000 Subject: [PATCH] Update manifest and docs to 6.1.0 --- CHANGELOG.md | 7 + VenafiPS/VenafiPS.psd1 | 4 +- docs/changelog.md | 7 + docs/functions/Add-VcTeamOwner.md | 13 +- docs/functions/Export-VcCertificate.md | 86 ++---- docs/functions/Find-VcCertificate.md | 51 +++- docs/functions/Get-VcTeam.md | 8 +- docs/functions/Import-VcCertificate.md | 75 ++---- docs/functions/New-VcMachine.md | 193 +++++--------- docs/functions/New-VcMachineCommonKeystore.md | 251 ++++++++---------- docs/functions/New-VcMachineIis.md | 195 ++++++-------- docs/functions/Set-VcApplication.md | 10 +- docs/functions/Set-VcTeam.md | 33 ++- 13 files changed, 427 insertions(+), 506 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b7ca8aba..20554ddc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 6.1.0 +- Add `Get-VcData` private function to centralize retrieving VC data for non search objects +- Better messaging when VSats aren't available, [#242](https://github.com/Venafi/VenafiPS/issues/242) +- Add messaging when PSSodium cannot be loaded, [#239](https://github.com/Venafi/VenafiPS/issues/239) +- Add workaround for TLSPDC API failure when importing PKCS12 + ## 6.0.6 - Fix incorrect path for Sodium in `Export-VcCertificate`, [#234](https://github.com/Venafi/VenafiPS/issues/234) @@ -632,5 +638,6 @@ This is a major release. Although every attempt has been made to be backwards c + diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1 index 97f94094..46158948 100644 --- a/VenafiPS/VenafiPS.psd1 +++ b/VenafiPS/VenafiPS.psd1 @@ -3,7 +3,7 @@ # # Generated by: Venafi # -# Generated on: 12/13/2023 +# Generated on: 01/07/2024 # @{ @@ -12,7 +12,7 @@ RootModule = 'VenafiPS.psm1' # Version number of this module. -ModuleVersion = '6.1' +ModuleVersion = '6.1.0' # Supported PSEditions # CompatiblePSEditions = @() diff --git a/docs/changelog.md b/docs/changelog.md index d56941c1..f8c81de7 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,9 @@ +## 6.1.0 +- Add `Get-VcData` private function to centralize retrieving VC data for non search objects +- Better messaging when VSats aren't available, [#242](https://github.com/Venafi/VenafiPS/issues/242) +- Add messaging when PSSodium cannot be loaded, [#239](https://github.com/Venafi/VenafiPS/issues/239) +- Add workaround for TLSPDC API failure when importing PKCS12 + ## 6.0.6 - Fix incorrect path for Sodium in `Export-VcCertificate`, [#234](https://github.com/Venafi/VenafiPS/issues/234) @@ -632,5 +638,6 @@ This is a major release. Although every attempt has been made to be backwards c + diff --git a/docs/functions/Add-VcTeamOwner.md b/docs/functions/Add-VcTeamOwner.md index b51c34c8..64534958 100644 --- a/docs/functions/Add-VcTeamOwner.md +++ b/docs/functions/Add-VcTeamOwner.md @@ -6,7 +6,7 @@ Add owners to a team ## SYNTAX ``` -Add-VcTeamOwner [-ID] [-Owner] [[-VenafiSession] ] [] +Add-VcTeamOwner [-Team] [-Owner] [[-VenafiSession] ] [] ``` ## DESCRIPTION @@ -16,21 +16,20 @@ Add owners to a TLSPC team ### EXAMPLE 1 ``` -Add-VcTeamOwner -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -Owner @('ca7ff555-88d2-4bfc-9efa-2630ac44c1f3', 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f4') +Add-VcTeamOwner -Team 'DevOps' -Owner @('ca7ff555-88d2-4bfc-9efa-2630ac44c1f3', 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f4') ``` Add owners ## PARAMETERS -### -ID -Team ID. -This is the unique guid obtained from Get-VcTeam. +### -Team +Team ID or name ```yaml Type: String Parameter Sets: (All) -Aliases: PrefixedUniversal, Guid +Aliases: ID Required: True Position: 1 @@ -77,7 +76,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### ID +### Team ## OUTPUTS ## NOTES diff --git a/docs/functions/Export-VcCertificate.md b/docs/functions/Export-VcCertificate.md index a2193bc1..a0e94cb4 100644 --- a/docs/functions/Export-VcCertificate.md +++ b/docs/functions/Export-VcCertificate.md @@ -1,7 +1,7 @@ # Export-VcCertificate ## SYNOPSIS -Export certificate data from TLSPC +{{ Fill in the Synopsis }} ## SYNTAX @@ -11,45 +11,21 @@ Export-VcCertificate [-ID] [[-PrivateKeyPassword] ] [-Include ``` ## DESCRIPTION -Export certificate data in PEM format. -You can retrieve the certificate, chain, and key. +{{ Fill in the Description }} ## EXAMPLES -### EXAMPLE 1 -``` -$certId | Export-VcCertificate -``` - -Export certificate data - -### EXAMPLE 2 -``` -$certId | Export-VcCertificate -PrivateKeyPassword 'myPassw0rd!' +### Example 1 +```powershell +PS C:\> {{ Add example code here }} ``` -Export certificate and private key data - -### EXAMPLE 3 -``` -$cert | Export-VcCertificate -OutPath '~/temp' -``` - -Get certificate data and save to a file - -### EXAMPLE 4 -``` -$cert | Export-VcCertificate -IncludeChain -``` - -Get certificate data with the certificate chain included. +{{ Add example description here }} ## PARAMETERS ### -ID -Certificate ID, also known as uuid. -Use Find-VcCertificate or Get-VcCertificate to determine the ID. -You can pipe those functions as well. +{{ Fill ID Description }} ```yaml Type: String @@ -57,63 +33,59 @@ Parameter Sets: (All) Aliases: certificateId Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PrivateKeyPassword -Password required to include the private key. -You can either provide a String, SecureString, or PSCredential. +### -IncludeChain +{{ Fill IncludeChain Description }} ```yaml -Type: PSObject +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeChain -Include the certificate chain with the exported certificate. +### -OutPath +{{ Fill OutPath Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: False +Position: 2 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutPath -Folder path to save the certificate to. -The name of the file will be determined automatically. -For each certificate a directory will be created in this folder with the format Name-ID. +### -PrivateKeyPassword +{{ Fill PrivateKeyPassword Description }} ```yaml -Type: String +Type: PSObject Parameter Sets: (All) Aliases: Required: False -Position: 3 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ThrottleLimit -Limit the number of threads when running in parallel; the default is 100. -Applicable to PS v7+ only. +{{ Fill ThrottleLimit Description }} ```yaml Type: Int32 @@ -121,16 +93,14 @@ Parameter Sets: (All) Aliases: Required: False -Position: 4 -Default value: 100 +Position: 3 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -VenafiSession -Authentication for the function. -The value defaults to the script session object $VenafiSession created by New-VenafiSession. -A TLSPC key can also provided. +{{ Fill VenafiSession Description }} ```yaml Type: PSObject @@ -138,7 +108,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 5 +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -149,10 +119,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### ID +### System.String ## OUTPUTS -### PSCustomObject +### System.Object ## NOTES ## RELATED LINKS diff --git a/docs/functions/Find-VcCertificate.md b/docs/functions/Find-VcCertificate.md index 73af2241..3b483a57 100644 --- a/docs/functions/Find-VcCertificate.md +++ b/docs/functions/Find-VcCertificate.md @@ -9,8 +9,9 @@ Find certificates in TLSPC ``` Find-VcCertificate [-Name ] [-KeyLength ] [-Serial ] [-Fingerprint ] [-IsSelfSigned] [-Status ] [-ExpireBefore ] [-ExpireAfter ] [-Version ] - [-SanDns ] [-Application ] [-Order ] [-ApplicationDetail] [-OwnerDetail] - [-First ] [-VenafiSession ] [] + [-SanDns ] [-Application ] [-Tag ] [-CN ] [-Issuer ] + [-Order ] [-ApplicationDetail] [-OwnerDetail] [-First ] [-VenafiSession ] + [] ``` ### Filter @@ -267,6 +268,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Tag +One or more tags associated with the certificate. +You can specify either just a tag name or name:value. + +```yaml +Type: String[] +Parameter Sets: All +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CN +Search for certificates where the subject CN matches all of part of the value + +```yaml +Type: String +Parameter Sets: All +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Issuer +Search by issuer name + +```yaml +Type: String +Parameter Sets: All +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Filter Array or multidimensional array of fields and values to filter on. Each array should be of the format @(field, comparison operator, value). diff --git a/docs/functions/Get-VcTeam.md b/docs/functions/Get-VcTeam.md index 01df1a80..65eb38d5 100644 --- a/docs/functions/Get-VcTeam.md +++ b/docs/functions/Get-VcTeam.md @@ -7,7 +7,7 @@ Get team info ### ID ``` -Get-VcTeam [-ID] [-VenafiSession ] [] +Get-VcTeam [-Team] [-VenafiSession ] [] ``` ### All @@ -44,13 +44,13 @@ Get info for all teams ## PARAMETERS -### -ID -Team name or guid. +### -Team +{{ Fill Team Description }} ```yaml Type: String[] Parameter Sets: ID -Aliases: teamID, owningTeam, owningTeams, owningTeamId, ownedTeams +Aliases: teamID, owningTeam, owningTeams, owningTeamId, ownedTeams, ID Required: True Position: 1 diff --git a/docs/functions/Import-VcCertificate.md b/docs/functions/Import-VcCertificate.md index 553af736..faf202fc 100644 --- a/docs/functions/Import-VcCertificate.md +++ b/docs/functions/Import-VcCertificate.md @@ -1,7 +1,7 @@ # Import-VcCertificate ## SYNOPSIS -Import one or more certificates +{{ Fill in the Synopsis }} ## SYNTAX @@ -24,46 +24,26 @@ Import-VcCertificate -Data [-Pkcs12] -PrivateKeyPassword [-T ``` ## DESCRIPTION -Import one or more certificates and their private keys. -Currently PKCS #8 and PKCS #12 (.pfx or .p12) are supported. +{{ Fill in the Description }} ## EXAMPLES -### EXAMPLE 1 +### Example 1 +```powershell +PS C:\> {{ Add example code here }} ``` -Import-VcCertificate -CertificatePath c:\www.VenafiPS.com.pfx -``` - -Import a certificate/key -### EXAMPLE 2 -``` -$p12 = Export-VdcCertificate -Path '\ved\policy\my.cert.com' -Pkcs12 -PrivateKeyPassword 'myPassw0rd!' -$p12 | Import-VcCertificate -Pkcs12 -PrivateKeyPassword 'myPassw0rd!' -VenafiSession $vaas_key -``` - -Export from TLSPDC and import into TLSPC. -As $VenafiSession can only point to one platform at a time, in this case TLSPDC, the session needs to be overridden for the import. - -### EXAMPLE 3 -``` -$p12 = Find-VdcCertificate -Path '\ved\policy\certs' -Recursive | Export-VdcCertificate -Pkcs12 -PrivateKeyPassword 'myPassw0rd!' -$p12 | Import-VcCertificate -Pkcs12 -PrivateKeyPassword 'myPassw0rd!' -VenafiSession $vaas_key -``` - -Bulk export from TLSPDC and import into TLSPC. -As $VenafiSession can only point to one platform at a time, in this case TLSPDC, the session needs to be overridden for the import. +{{ Add example description here }} ## PARAMETERS -### -Path -Path to a certificate file. -Provide either this or -Data. +### -Data +{{ Fill Data Description }} ```yaml Type: String -Parameter Sets: ByFile -Aliases: FullName, CertificatePath +Parameter Sets: Pkcs8, Pkcs12 +Aliases: CertificateData Required: True Position: Named @@ -72,14 +52,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Data -Contents of a certificate/key to import. -Provide either this or -Path. +### -Path +{{ Fill Path Description }} ```yaml Type: String -Parameter Sets: Pkcs8, Pkcs12 -Aliases: CertificateData +Parameter Sets: ByFile +Aliases: FullName, CertificatePath Required: True Position: Named @@ -89,7 +68,7 @@ Accept wildcard characters: False ``` ### -Pkcs12 -Provided -Data is in PKCS #12 format +{{ Fill Pkcs12 Description }} ```yaml Type: SwitchParameter @@ -98,13 +77,13 @@ Aliases: Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Pkcs8 -Provided -Data is in PKCS #8 format +{{ Fill Pkcs8 Description }} ```yaml Type: SwitchParameter @@ -113,13 +92,13 @@ Aliases: Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -PrivateKeyPassword -Password the private key was encrypted with +{{ Fill PrivateKeyPassword Description }} ```yaml Type: PSObject @@ -134,9 +113,7 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Limit the number of threads when running in parallel; the default is 10. -Applicable to PS v7+ only. -100 keystores will be imported at a time so it's less important to have a very high throttle limit. +{{ Fill ThrottleLimit Description }} ```yaml Type: Int32 @@ -145,15 +122,13 @@ Aliases: Required: False Position: Named -Default value: 10 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -VenafiSession -Authentication for the function. -The value defaults to the script session object $VenafiSession created by New-VenafiSession. -A TLSPC key can also provided. +{{ Fill VenafiSession Description }} ```yaml Type: PSObject @@ -172,12 +147,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Path, Data +### System.String ## OUTPUTS +### System.Object ## NOTES ## RELATED LINKS - -[https://developer.venafi.com/tlsprotectcloud/reference/certificates_import](https://developer.venafi.com/tlsprotectcloud/reference/certificates_import) - diff --git a/docs/functions/New-VcMachine.md b/docs/functions/New-VcMachine.md index 2987ff9f..aa23baa5 100644 --- a/docs/functions/New-VcMachine.md +++ b/docs/functions/New-VcMachine.md @@ -1,7 +1,7 @@ # New-VcMachine ## SYNOPSIS -Create 1 or more machines +{{ Fill in the Synopsis }} ## SYNTAX @@ -20,63 +20,25 @@ New-VcMachine -Name -MachineType [-VSatellite ] -Owner ``` ## DESCRIPTION -This creation function is to be used for 'simple' machine types, eg. -F5 and Citrix, where hostname, credential and optionally port are used. -Machine creation for types with additional functionality will have dedicated functions, eg. -New-VcMachineIis. -By default, the machine details will be verified by performing a test connection; this can be turned off with -NoVerify. -Creation will occur in parallel and PowerShell v7+ is required. +{{ Fill in the Description }} ## EXAMPLES -### EXAMPLE 1 -``` -$params = @{ - Name = 'c1' - MachineType = 'Citrix ADC' - Owner = 'MyTeam' - Hostname = 'c1.company.com' - Credential = $cred -} -New-VcMachine @params -``` - -machineId : cf7cfdc0-2b2a-11ee-9546-5136c4b21504 -testConnection : @{Success=True; Error=; WorkflowID=c39310ee-51fc-49f3-8b5b-e504e1bc43d2} -companyId : 20b24f81-b22b-11ea-91f3-ebd6dea5453f -name : c1 -machineType : Citrix ADC -pluginId : ff645e14-bd1a-11ed-a009-ce063932f86d -integrationId : cf7c8014-2b2a-11ee-9a03-fa8930555887 -edgeInstanceId : 0bc771e1-7abe-4339-9fcd-93fffe9cba7f -creationDate : 7/25/2023 4:35:36 PM -modificationDate : 7/25/2023 4:35:36 PM -status : UNVERIFIED -owningTeamId : 59920180-a3e2-11ec-8dcd-3fcbf84c7da7 - -Create a new Citrix machine - -### EXAMPLE 2 -``` -[pscustomobject] @{ - Name = 'c1.company.com' - MachineType = 'Citrix ADC' - Owner = 'MyTeam' - Credential = $cred -} | New-VcMachine +### Example 1 +```powershell +PS C:\> {{ Add example code here }} ``` -Use pipeline data to create a machine. -More than 1 machine can be sent thru the pipeline and they will be created in parallel. +{{ Add example description here }} ## PARAMETERS -### -Name -Machine name +### -ConnectionDetail +{{ Fill ConnectionDetail Description }} ```yaml -Type: String -Parameter Sets: (All) +Type: Hashtable +Parameter Sets: AdvancedMachine Aliases: Required: True @@ -86,14 +48,12 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -MachineType -Machine type by either ID or name, eg. -'Citrix ADC'. -A list can be found by create a new session and executing $VenafiSession.MachineType. +### -Credential +{{ Fill Credential Description }} ```yaml -Type: String -Parameter Sets: (All) +Type: PSCredential +Parameter Sets: BasicMachine Aliases: Required: True @@ -103,9 +63,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -VSatellite -ID or name of a vsatellite. -If not provided, the first vsatellite found will be used. +### -DekID +{{ Fill DekID Description }} ```yaml Type: String @@ -119,6 +78,9 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Hostname +{{ Fill Hostname Description }} + ```yaml Type: String Parameter Sets: BasicMachine @@ -131,8 +93,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Owner -ID or name of a team to be the owner of the machine +### -MachineType +{{ Fill MachineType Description }} ```yaml Type: String @@ -146,75 +108,68 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Tag -Optional list of tags to assign +### -Name +{{ Fill Name Description }} ```yaml -Type: String[] +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Status -Set the machine status to either 'DRAFT', 'VERIFIED', or 'UNVERIFIED'. -This optional field has been added for flexibility, but should not be needed under typical usage. -The platform will handle changing the status to the appropriate value. -Setting this to a value other than VERIFIED will affect the ability to initiate workflows. +### -NoVerify +{{ Fill NoVerify Description }} ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Hostname -IP or fqdn of the machine. -If this is to be the same value as -Name, this parameter can be ommitted. +### -Owner +{{ Fill Owner Description }} ```yaml Type: String -Parameter Sets: BasicMachine +Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Credential -Username/password to access the machine +### -PassThru +{{ Fill PassThru Description }} ```yaml -Type: PSCredential -Parameter Sets: BasicMachine +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Port -Optional port. -The default value will depend on the machine type. -Eg. -for Citrix ADC this is 443. +{{ Fill Port Description }} ```yaml Type: String @@ -228,89 +183,81 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ConnectionDetail -Full connection detail object to create a machine. -This is typically for use with other machine creation functions, but here for flexibility. +### -Status +{{ Fill Status Description }} ```yaml -Type: Hashtable -Parameter Sets: AdvancedMachine +Type: String +Parameter Sets: (All) Aliases: +Accepted values: DRAFT, VERIFIED, UNVERIFIED -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DekID -ID of the data encryption key +### -Tag +{{ Fill Tag Description }} ```yaml -Type: String -Parameter Sets: AdvancedMachine +Type: String[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -NoVerify -By default a connection to the host will be attempted. -Use this switch to turn off this behavior. -Not recommended. +### -ThrottleLimit +{{ Fill ThrottleLimit Description }} ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ThrottleLimit -Limit the number of threads when running in parallel; the default is 100. -Applicable to PS v7+ only. +### -VSatellite +{{ Fill VSatellite Description }} ```yaml -Type: Int32 -Parameter Sets: (All) +Type: String +Parameter Sets: AdvancedMachine Aliases: -Required: False +Required: True Position: Named -Default value: 100 -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -PassThru -Return newly created object - ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: BasicMachine Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` ### -VenafiSession -Authentication for the function. -The value defaults to the script session object $VenafiSession created by New-VenafiSession. -A TLSPC key can also provided. +{{ Fill VenafiSession Description }} ```yaml Type: PSObject @@ -329,9 +276,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### System.String +### System.String[] +### System.Management.Automation.PSCredential +### System.Collections.Hashtable ## OUTPUTS +### System.Object ## NOTES -To see a full list of tab-completion options, be sure to set the Tab option, Set-PSReadlineKeyHandler -Key Tab -Function MenuComplete. ## RELATED LINKS diff --git a/docs/functions/New-VcMachineCommonKeystore.md b/docs/functions/New-VcMachineCommonKeystore.md index 19d53469..1635d61f 100644 --- a/docs/functions/New-VcMachineCommonKeystore.md +++ b/docs/functions/New-VcMachineCommonKeystore.md @@ -1,7 +1,7 @@ # New-VcMachineCommonKeystore ## SYNOPSIS -Create a new common keystore machine +{{ Fill in the Synopsis }} ## SYNTAX @@ -36,360 +36,332 @@ New-VcMachineCommonKeystore -Name [-VSatellite ] -Owner {{ Add example code here }} ``` -machineId : a9b60a70-2b28-11ee-b5b5-4b044579acad -testConnection : @{Success=True; Error=; WorkflowID=c14e181b-82ea-423a-b0fd-c3fe9b218a64} -companyId : 20b24f81-b22b-11ea-91f3-ebd6dea5453f -name : ck1 -machineType : Common KeyStore (PEM, JKS, PKCS#12) -pluginId : 0e565e41-dd31-11ec-841d-a7d91c5a907c -integrationId : a9b5b842-2b28-11ee-9263-9e16d4b8a8c9 -edgeInstanceId : 0bc771e1-7abe-4339-9fcd-93fffe9cba7f -creationDate : 7/25/2023 4:20:14 PM -modificationDate : 7/25/2023 4:20:14 PM -status : UNVERIFIED -owningTeamId : 59920180-a3e2-11ec-8dcd-3fcbf84c7da7 - -Create a new machine with SSH password authentication +{{ Add example description here }} ## PARAMETERS -### -Name -Machine name +### -Credential +{{ Fill Credential Description }} ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -VSatellite -ID or name of a vsatellite. -If not provided, the first vsatellite found will be used. +### -DomainName +{{ Fill DomainName Description }} ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: WinrmKerberos Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Owner -ID or name of a team to be the owner of the machine +### -Hostname +{{ Fill Hostname Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Hostname -IP or fqdn of the machine. -If this is to be the same value as -Name, this parameter can be ommitted. +### -KeyDistributionCenter +{{ Fill KeyDistributionCenter Description }} ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: WinrmKerberos Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Credential -Username/password to access the machine. -If using key-based authentication over SSH, set the password to the private key. +### -Name +{{ Fill Name Description }} ```yaml -Type: PSCredential +Type: String Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Tag -Optional list of tags to assign +### -NoVerify +{{ Fill NoVerify Description }} ```yaml -Type: String[] +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Status -Set the machine status to either 'DRAFT', 'VERIFIED', or 'UNVERIFIED'. -This optional field has been added for flexibility, but should not be needed under typical usage. -The platform will handle changing the status to the appropriate value. -Setting this to a value other than VERIFIED will affect the ability to initiate workflows. +### -Owner +{{ Fill Owner Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -SshPassword -Connect to the target machine over SSH with username and password +### -PassThru +{{ Fill PassThru Description }} ```yaml Type: SwitchParameter -Parameter Sets: SshPassword +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) +Default value: None +Accept pipeline input: False Accept wildcard characters: False ``` -### -SshKey -Connect to the target machine over SSH with username and private key +### -Port +{{ Fill Port Description }} ```yaml -Type: SwitchParameter -Parameter Sets: SshKey +Type: Int32 +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WinrmBasic -Connect to the target machine over WinRM with Basic authentication +### -SPN +{{ Fill SPN Description }} ```yaml -Type: SwitchParameter -Parameter Sets: WinrmBasic +Type: String +Parameter Sets: WinrmKerberos Aliases: Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WinrmKerberos -Connect to the target machine over WinRM with Kerberos authentication +### -SkipCertificateCheck +{{ Fill SkipCertificateCheck Description }} ```yaml Type: SwitchParameter -Parameter Sets: WinrmKerberos +Parameter Sets: WinrmBasic, WinrmKerberos Aliases: -Required: True +Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Port -Optional SSH/WinRM port. -The default for SSH is 22 and WinRM is 5985. +### -SshKey +{{ Fill SshKey Description }} ```yaml -Type: Int32 -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: SshKey Aliases: -Required: False +Required: True Position: Named -Default value: 0 +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -UseTls -Connect with WinRM over HTTPS as opposed to the default of HTTP +### -SshPassword +{{ Fill SshPassword Description }} ```yaml Type: SwitchParameter -Parameter Sets: WinrmBasic, WinrmKerberos +Parameter Sets: SshPassword Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -SkipCertificateCheck -If connecting with WinRM over HTTPS and you wish to bypass certificate validation +### -Status +{{ Fill Status Description }} ```yaml -Type: SwitchParameter -Parameter Sets: WinrmBasic, WinrmKerberos +Type: String +Parameter Sets: (All) Aliases: +Accepted values: DRAFT, VERIFIED, UNVERIFIED Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DomainName -Machine domain name for WinRM +### -Tag +{{ Fill Tag Description }} ```yaml -Type: String -Parameter Sets: WinrmKerberos +Type: String[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -KeyDistributionCenter -Address or hostname of the key distribution center for WinRM +### -ThrottleLimit +{{ Fill ThrottleLimit Description }} ```yaml -Type: String -Parameter Sets: WinrmKerberos +Type: Int32 +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -SPN -Service Principal Name, eg. -WSMAN/server.company.com, for WinRM +### -UseTls +{{ Fill UseTls Description }} ```yaml -Type: String -Parameter Sets: WinrmKerberos +Type: SwitchParameter +Parameter Sets: WinrmBasic, WinrmKerberos Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -NoVerify -By default a connection to the host will be attempted. -Use this switch to turn off this behavior. -Not recommended. +### -VSatellite +{{ Fill VSatellite Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ThrottleLimit -Limit the number of threads when running in parallel; the default is 100. -Applicable to PS v7+ only. +### -VenafiSession +{{ Fill VenafiSession Description }} ```yaml -Type: Int32 +Type: PSObject Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 100 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Return newly created object +### -WinrmBasic +{{ Fill WinrmBasic Description }} ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: WinrmBasic Aliases: -Required: False +Required: True Position: Named -Default value: False -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -VenafiSession -Authentication for the function. -The value defaults to the script session object $VenafiSession created by New-VenafiSession. -A TLSPC key can also provided. +### -WinrmKerberos +{{ Fill WinrmKerberos Description }} ```yaml -Type: PSObject -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: WinrmKerberos Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -398,9 +370,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### System.String +### System.Management.Automation.PSCredential +### System.String[] +### System.Management.Automation.SwitchParameter +### System.Int32 ## OUTPUTS -### PSCustomObject, if PassThru provided +### System.Object ## NOTES ## RELATED LINKS diff --git a/docs/functions/New-VcMachineIis.md b/docs/functions/New-VcMachineIis.md index 1b0e98e7..129939d5 100644 --- a/docs/functions/New-VcMachineIis.md +++ b/docs/functions/New-VcMachineIis.md @@ -1,7 +1,7 @@ # New-VcMachineIis ## SYNOPSIS -Create a new IIS machine +{{ Fill in the Synopsis }} ## SYNTAX @@ -22,297 +22,262 @@ New-VcMachineIis -Name [-VSatellite ] -Owner [-Hostnam ``` ## DESCRIPTION -Create a new IIS machine with either basic or kerberos authentication. -By default, the machine details will be verified by performing a test connection; this can be turned off with -NoVerify. -Creation will occur in parallel and PowerShell v7+ is required. +{{ Fill in the Description }} ## EXAMPLES -### EXAMPLE 1 -``` -$params = @{ - Name = 'iis1' - Owner = 'MyTeam' - Hostname = 'iis1.company.com' - Credential = $cred - DomainName = 'company.com' - KeyDistributionCenter = '1.2.3.4' - SPN = 'WSMAN/iis1.company.com' -} -New-VcMachineIis @params +### Example 1 +```powershell +PS C:\> {{ Add example code here }} ``` -machineId : 55e054d0-2b2a-11ee-9546-5136c4b21504 -testConnection : @{Success=True; Error=; WorkflowID=c39310ee-51fc-49f3-8b5b-e504e1bc43d2} -companyId : 20b24f81-b22b-11ea-91f3-ebd6dea5453f -name : iis1 -machineType : Microsoft IIS -pluginId : be453281-d080-11ec-a07a-6d5bc1b54078 -integrationId : 55df8877-2b2a-11ee-9264-9e16d4b8a8c9 -edgeInstanceId : 0bc771e1-7abe-4339-9fcd-93fffe9cba7f -creationDate : 7/25/2023 4:32:12 PM -modificationDate : 7/25/2023 4:32:12 PM -status : UNVERIFIED -owningTeamId : 59920180-a3e2-11ec-8dcd-3fcbf84c7da7 - -Create a new machine with Kerberos authentication +{{ Add example description here }} ## PARAMETERS -### -Name -Machine name +### -Credential +{{ Fill Credential Description }} ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -VSatellite -ID or name of a vsatellite. -If not provided, the first vsatellite found will be used. +### -DomainName +{{ Fill DomainName Description }} ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: WinrmKerberos Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Owner -ID or name of a team to be the owner of the machine +### -Hostname +{{ Fill Hostname Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Hostname -IP or fqdn of the machine. -If this is to be the same value as -Name, this parameter can be ommitted. +### -KeyDistributionCenter +{{ Fill KeyDistributionCenter Description }} ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: WinrmKerberos Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Credential -Username/password to access the machine +### -Name +{{ Fill Name Description }} ```yaml -Type: PSCredential +Type: String Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Tag -Optional list of tags to assign +### -NoVerify +{{ Fill NoVerify Description }} ```yaml -Type: String[] +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Status -Set the machine status to either 'DRAFT', 'VERIFIED', or 'UNVERIFIED'. -This optional field has been added for flexibility, but should not be needed under typical usage. -The platform will handle changing the status to the appropriate value. -Setting this to a value other than VERIFIED will affect the ability to initiate workflows. +### -Owner +{{ Fill Owner Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Port -Optional WinRM port. -The default is 5985. +### -PassThru +{{ Fill PassThru Description }} ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 0 -Accept pipeline input: True (ByPropertyName) +Default value: None +Accept pipeline input: False Accept wildcard characters: False ``` -### -UseTls -Connect over HTTPS as opposed to the default of HTTP +### -Port +{{ Fill Port Description }} ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -SkipCertificateCheck -If connecting over HTTPS and you wish to bypass certificate validation +### -SPN +{{ Fill SPN Description }} ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: WinrmKerberos Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DomainName -Machine domain name +### -SkipCertificateCheck +{{ Fill SkipCertificateCheck Description }} ```yaml -Type: String -Parameter Sets: WinrmKerberos +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -KeyDistributionCenter -Address or hostname of the key distribution center +### -Status +{{ Fill Status Description }} ```yaml Type: String -Parameter Sets: WinrmKerberos +Parameter Sets: (All) Aliases: +Accepted values: DRAFT, VERIFIED, UNVERIFIED -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -SPN -Service Principal Name, eg. -WSMAN/server.company.com +### -Tag +{{ Fill Tag Description }} ```yaml -Type: String -Parameter Sets: WinrmKerberos +Type: String[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -NoVerify -By default a connection to the host will be attempted. -Use this switch to turn off this behavior. -Not recommended. +### -ThrottleLimit +{{ Fill ThrottleLimit Description }} ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ThrottleLimit -Limit the number of threads when running in parallel; the default is 100. -Applicable to PS v7+ only. +### -UseTls +{{ Fill UseTls Description }} ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 100 -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -PassThru -Return newly created object +### -VSatellite +{{ Fill VSatellite Description }} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` ### -VenafiSession -Authentication for the function. -The value defaults to the script session object $VenafiSession created by New-VenafiSession. -A TLSPC key can also provided. +{{ Fill VenafiSession Description }} ```yaml Type: PSObject @@ -331,8 +296,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### System.String +### System.Management.Automation.PSCredential +### System.String[] +### System.Int32 +### System.Management.Automation.SwitchParameter ## OUTPUTS +### System.Object ## NOTES ## RELATED LINKS diff --git a/docs/functions/Set-VcApplication.md b/docs/functions/Set-VcApplication.md index 9bdaab2c..5b238fb7 100644 --- a/docs/functions/Set-VcApplication.md +++ b/docs/functions/Set-VcApplication.md @@ -6,8 +6,8 @@ ## SYNTAX ``` -Set-VcApplication [-ID] [[-Name] ] [[-TeamOwner] ] [-NoOverwrite] [-PassThru] - [[-VenafiSession] ] [] +Set-VcApplication [-Application] [[-Name] ] [[-TeamOwner] ] [-NoOverwrite] + [-PassThru] [[-VenafiSession] ] [] ``` ## DESCRIPTION @@ -24,13 +24,13 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ID -{{ Fill ID Description }} +### -Application +{{ Fill Application Description }} ```yaml Type: String Parameter Sets: (All) -Aliases: applicationId +Aliases: applicationId, ID Required: True Position: 0 diff --git a/docs/functions/Set-VcTeam.md b/docs/functions/Set-VcTeam.md index 1e78c68d..4130dd8c 100644 --- a/docs/functions/Set-VcTeam.md +++ b/docs/functions/Set-VcTeam.md @@ -5,8 +5,15 @@ Update an existing team ## SYNTAX +### NoOverwrite (Default) ``` -Set-VcTeam -ID [-Name ] [-Role ] [-UserMatchingRule ] [-NoOverwrite] +Set-VcTeam -Team [-Name ] [-Role ] [-UserMatchingRule ] [-PassThru] + [-VenafiSession ] [] +``` + +### Overwrite +``` +Set-VcTeam -Team [-Name ] [-Role ] -UserMatchingRule [-NoOverwrite] [-PassThru] [-VenafiSession ] [] ``` @@ -59,13 +66,13 @@ Update many teams ## PARAMETERS -### -ID -Team ID or name +### -Team +{{ Fill Team Description }} ```yaml Type: String Parameter Sets: (All) -Aliases: teamId +Aliases: teamId, ID Required: True Position: Named @@ -118,7 +125,7 @@ To append use -NoOverwrite. ```yaml Type: Hashtable[] -Parameter Sets: (All) +Parameter Sets: NoOverwrite Aliases: Required: False @@ -128,15 +135,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +```yaml +Type: Hashtable[] +Parameter Sets: Overwrite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoOverwrite Append to existing user matching rules as opposed to overwriting ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Overwrite Aliases: -Required: False +Required: True Position: Named Default value: False Accept pipeline input: False