diff --git a/CHANGELOG.md b/CHANGELOG.md index 2803dcba..616b3d30 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,17 @@ +## 6.7.0 +- Add `Set-VcCertificateRequest` to approve requests. Optionally, use `-Wait` for the certificate to be issued and certificate details to be available. +- Add `Initialize-PSSodium -Force` to force installation of the module if it doesn't exist. This is used by the new parameters `Export-VcCertificate -Force`, `Import-VcCertificate -Force`, `New-VcMachine -Force`, `New-VcMachineCommonKeystore -Force`, and `New-VcMachineIis -Force`. +- Update `New-VcCertificate` to retrieve default validity date from the issuing template instead of a set 90 days +- Fix `Find-VdcCertificate -CountOnly` error [#309](https://github.com/Venafi/VenafiPS/issues/309) +- Updates to better facilitate moving certificates/keys between environments. + - Update `Export-VcCertificate -PKCS12` to allow exporting to base64 in addition to a file. + - Add standard names for Format in return objects in TLSPC and TLSPDC. + - Add PrivateKeyPasswordCredential in return objects to keep from having to provide again further down the pipeline +- Add `Invoke-VcGraphQL` for queries and mutations. This isn't used for too much as of now, but the framework is here for when it's needed. +- Update `Get-VcData` to use `Invoke-VcGraphQL` for Application and Team id and names. Quite often we are just converting names into IDs so graphql should give us a performance bump as opposed to the REST api. +- Deprecated `Add-VcCertificateAssociation` + + ## 6.6.1 - Fix bogus error during `New-VcMachineCommonKeystore` [#304](https://github.com/Venafi/VenafiPS/issues/304) - Update VC machine creation components due to API deprecation @@ -752,5 +766,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 967dab67..f7851cb0 100644 --- a/VenafiPS/VenafiPS.psd1 +++ b/VenafiPS/VenafiPS.psd1 @@ -3,7 +3,7 @@ # # Generated by: Greg Brownstein # -# Generated on: 11/28/2024 +# Generated on: 12/12/2024 # @{ @@ -12,7 +12,7 @@ RootModule = 'VenafiPS.psm1' # Version number of this module. -ModuleVersion = '6.7' +ModuleVersion = '6.7.0' # Supported PSEditions # CompatiblePSEditions = @() @@ -69,20 +69,19 @@ PowerShellVersion = '5.1' # NestedModules = @() # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. -FunctionsToExport = 'Add-VcTeamMember', 'Add-VcTeamOwner', - 'Add-VdcAdaptableHash', 'Add-VdcCertificateAssociation', - 'Add-VdcEngineFolder', 'Add-VdcTeamMember', 'Add-VdcTeamOwner', - 'Convert-VdcObject', 'ConvertTo-VdcGuid', 'ConvertTo-VdcPath', - 'Export-VcCertificate', 'Export-VdcCertificate', - 'Export-VdcVaultObject', 'Find-VcCertificate', - 'Find-VcCertificateInstance', 'Find-VcCertificateRequest', - 'Find-VcLog', 'Find-VcMachine', 'Find-VcMachineIdentity', - 'Find-VdcCertificate', 'Find-VdcClient', 'Find-VdcEngine', - 'Find-VdcIdentity', 'Find-VdcObject', 'Find-VdcVaultId', - 'Get-VcApplication', 'Get-VcCertificate', 'Get-VcConnector', - 'Get-VcIssuingTemplate', 'Get-VcMachine', 'Get-VcMachineIdentity', - 'Get-VcSatellite', 'Get-VcTag', 'Get-VcTeam', 'Get-VcUser', - 'Get-VcWebhook', 'Get-VdcAttribute', 'Get-VdcCertificate', +FunctionsToExport = 'Add-VcTeamMember', 'Add-VcTeamOwner', 'Add-VdcAdaptableHash', + 'Add-VdcCertificateAssociation', 'Add-VdcEngineFolder', + 'Add-VdcTeamMember', 'Add-VdcTeamOwner', 'Convert-VdcObject', + 'ConvertTo-VdcGuid', 'ConvertTo-VdcPath', 'Export-VcCertificate', + 'Export-VdcCertificate', 'Export-VdcVaultObject', + 'Find-VcCertificate', 'Find-VcCertificateInstance', + 'Find-VcCertificateRequest', 'Find-VcLog', 'Find-VcMachine', + 'Find-VcMachineIdentity', 'Find-VdcCertificate', 'Find-VdcClient', + 'Find-VdcEngine', 'Find-VdcIdentity', 'Find-VdcObject', + 'Find-VdcVaultId', 'Get-VcApplication', 'Get-VcCertificate', + 'Get-VcConnector', 'Get-VcIssuingTemplate', 'Get-VcMachine', + 'Get-VcMachineIdentity', 'Get-VcSatellite', 'Get-VcTag', 'Get-VcTeam', + 'Get-VcUser', 'Get-VcWebhook', 'Get-VdcAttribute', 'Get-VdcCertificate', 'Get-VdcClassAttribute', 'Get-VdcCredential', 'Get-VdcCustomField', 'Get-VdcEngineFolder', 'Get-VdcIdentity', 'Get-VdcIdentityAttribute', 'Get-VdcObject', 'Get-VdcPermission', 'Get-VdcSystemStatus', @@ -109,7 +108,8 @@ FunctionsToExport = 'Add-VcTeamMember', 'Add-VcTeamOwner', 'Set-VdcCredential', 'Set-VdcPermission', 'Set-VdcWorkflowTicketStatus', 'Test-VdcIdentity', 'Test-VdcObject', 'Test-VdcToken', 'Write-VdcLog', 'Set-VcCertificate', - 'Get-VcSatelliteWorker', 'Remove-VcSatelliteWorker', 'Set-VcCertificateRequest' + 'Get-VcSatelliteWorker', 'Remove-VcSatelliteWorker', + 'Set-VcCertificateRequest' # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. CmdletsToExport = @() diff --git a/docs/changelog.md b/docs/changelog.md index eb3bca1a..750f8126 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,17 @@ +## 6.7.0 +- Add `Set-VcCertificateRequest` to approve requests. Optionally, use `-Wait` for the certificate to be issued and certificate details to be available. +- Add `Initialize-PSSodium -Force` to force installation of the module if it doesn't exist. This is used by the new parameters `Export-VcCertificate -Force`, `Import-VcCertificate -Force`, `New-VcMachine -Force`, `New-VcMachineCommonKeystore -Force`, and `New-VcMachineIis -Force`. +- Update `New-VcCertificate` to retrieve default validity date from the issuing template instead of a set 90 days +- Fix `Find-VdcCertificate -CountOnly` error [#309](https://github.com/Venafi/VenafiPS/issues/309) +- Updates to better facilitate moving certificates/keys between environments. + - Update `Export-VcCertificate -PKCS12` to allow exporting to base64 in addition to a file. + - Add standard names for Format in return objects in TLSPC and TLSPDC. + - Add PrivateKeyPasswordCredential in return objects to keep from having to provide again further down the pipeline +- Add `Invoke-VcGraphQL` for queries and mutations. This isn't used for too much as of now, but the framework is here for when it's needed. +- Update `Get-VcData` to use `Invoke-VcGraphQL` for Application and Team id and names. Quite often we are just converting names into IDs so graphql should give us a performance bump as opposed to the REST api. +- Deprecated `Add-VcCertificateAssociation` + + ## 6.6.1 - Fix bogus error during `New-VcMachineCommonKeystore` [#304](https://github.com/Venafi/VenafiPS/issues/304) - Update VC machine creation components due to API deprecation @@ -752,5 +766,6 @@ This is a major release. Although every attempt has been made to be backwards c + diff --git a/docs/functions/Add-VcCertificateAssociation.md b/docs/functions/Add-VcCertificateAssociation.md deleted file mode 100644 index 44b50172..00000000 --- a/docs/functions/Add-VcCertificateAssociation.md +++ /dev/null @@ -1,157 +0,0 @@ -# Add-VcCertificateAssociation - -## SYNOPSIS -Associate certificates with applications - -## SYNTAX - -``` -Add-VcCertificateAssociation [-Certificate] [-Application] [-NoOverwrite] [-PassThru] - [[-VenafiSession] ] [-ProgressAction ] [] -``` - -## DESCRIPTION -Associate one or more certificates with one or more applications. -The associated applications can either replace or be added to existing. -By default, applications will be replaced. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-VcCertificateAssociation -Certificate '7ac56ec0-2017-11ee-9417-a17dd25b82f9' -Application '96fc9310-67ec-11eb-a8a7-794fe75a8e6f' -``` - -Associate a certificate to an application - -### EXAMPLE 2 -``` -Add-VcCertificateAssociation -Certificate '7ac56ec0-2017-11ee-9417-a17dd25b82f9' -Application '96fc9310-67ec-11eb-a8a7-794fe75a8e6f', 'a05013bd-921d-440c-bc22-c9ead5c8d548' -``` - -Associate a certificate to multiple applications - -### EXAMPLE 3 -``` -Find-VcCertificate -First 5 | Add-VcCertificateAssociation -Application 'My Awesome App' -``` - -Associate multiple certificates to 1 application by name - -### EXAMPLE 4 -``` -Add-VcCertificateAssociation -Certificate 'www.barron.com' -Application '96fc9310-67ec-11eb-a8a7-794fe75a8e6f' -NoOverwrite -``` - -Associate a certificate, by name, to another application, keeping the existing - -## PARAMETERS - -### -Certificate -Certificate ID or name to be associated. -If a name is provided and multiple certificates are found, they will all be associated. -Tab completion can be used for a list of certificate names to choose from. -Type 3 or more characters for tab completion to work. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: certificateID - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Application -One or more application IDs or names. -Tab completion can be used for a list of application names. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: ApplicationID - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoOverwrite -Append to existing applications as opposed to overwriting - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return the newly updated certificate object(s) - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: Key - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Certificate -## OUTPUTS - -### PSCustomObject -## NOTES - -## RELATED LINKS diff --git a/docs/functions/Export-VcCertificate.md b/docs/functions/Export-VcCertificate.md index 0e9dba9f..1c26df23 100644 --- a/docs/functions/Export-VcCertificate.md +++ b/docs/functions/Export-VcCertificate.md @@ -8,13 +8,15 @@ Export certificate data from TLSPC ### PEM (Default) ``` Export-VcCertificate -ID [-PrivateKeyPassword ] [-IncludeChain] [-OutPath ] - [-ThrottleLimit ] [-VenafiSession ] [-ProgressAction ] [] + [-ThrottleLimit ] [-Force] [-VenafiSession ] [-ProgressAction ] + [] ``` ### PKCS12 ``` -Export-VcCertificate -ID -PrivateKeyPassword -OutPath [-PKCS12] - [-ThrottleLimit ] [-VenafiSession ] [-ProgressAction ] [] +Export-VcCertificate -ID -PrivateKeyPassword [-OutPath ] [-PKCS12] + [-ThrottleLimit ] [-Force] [-VenafiSession ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -130,7 +132,7 @@ In the case of PKCS12, the file will be saved to the root of the folder. ```yaml Type: String -Parameter Sets: PEM +Parameter Sets: (All) Aliases: Required: False @@ -140,20 +142,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: PKCS12 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -PKCS12 -Export the certificate and private key in PKCS12 format. +Export the certificate and private key in PKCS12 format. +The default is PEM. Requires PowerShell v7.1+. ```yaml @@ -186,6 +177,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force +Force installation of PSSodium if not already installed + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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. @@ -228,7 +234,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### PSCustomObject ## NOTES -This function requires the use of sodium encryption. +This function requires PSSodium. +Install it from the PSGallery or use -Force to automatically install. PS v7.1+ is required. On Windows, the latest Visual C++ redist must be installed. See https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist. diff --git a/docs/functions/Find-VcCertificateRequest.md b/docs/functions/Find-VcCertificateRequest.md index c0e5d2d7..c5ffadc7 100644 --- a/docs/functions/Find-VcCertificateRequest.md +++ b/docs/functions/Find-VcCertificateRequest.md @@ -32,7 +32,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Status -Request status, either ISSUED or FAILED +Request status, one of 'NEW', 'PENDING', 'PENDING_APPROVAL', 'PENDING_FINAL_APPROVAL', 'REJECTED_APPROVAL', 'REQUESTED', 'ISSUED', 'REJECTED', 'CANCELLED', 'REVOKED', 'FAILED', 'DELETED' ```yaml Type: String diff --git a/docs/functions/Import-VcCertificate.md b/docs/functions/Import-VcCertificate.md index e0f222f0..5c0405d5 100644 --- a/docs/functions/Import-VcCertificate.md +++ b/docs/functions/Import-VcCertificate.md @@ -7,19 +7,26 @@ ### ByFile (Default) ``` -Import-VcCertificate -Path -PrivateKeyPassword [-ThrottleLimit ] - [-VenafiSession ] [-ProgressAction ] [] +Import-VcCertificate -FilePath [-ThrottleLimit ] [-Force] [-VenafiSession ] + [-ProgressAction ] [] +``` + +### Format +``` +Import-VcCertificate -Data -Format -PrivateKeyPasswordCredential + [-ThrottleLimit ] [-Force] [-VenafiSession ] [-ProgressAction ] + [] ``` -### Pkcs8 +### PKCS8 ``` -Import-VcCertificate -Data [-Pkcs8] -PrivateKeyPassword [-ThrottleLimit ] +Import-VcCertificate -Data [-PKCS8] -PrivateKeyPassword [-ThrottleLimit ] [-Force] [-VenafiSession ] [-ProgressAction ] [] ``` -### Pkcs12 +### PKCS12 ``` -Import-VcCertificate -Data [-Pkcs12] -PrivateKeyPassword [-ThrottleLimit ] +Import-VcCertificate -Data [-PKCS12] -PrivateKeyPassword [-ThrottleLimit ] [-Force] [-VenafiSession ] [-ProgressAction ] [] ``` @@ -42,8 +49,8 @@ PS C:\> {{ Add example code here }} ```yaml Type: String -Parameter Sets: Pkcs8, Pkcs12 -Aliases: CertificateData +Parameter Sets: Format, PKCS8, PKCS12 +Aliases: certificateData Required: True Position: Named @@ -52,8 +59,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Path -{{ Fill Path Description }} +### -FilePath +{{ Fill FilePath Description }} ```yaml Type: String @@ -67,12 +74,43 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Pkcs12 -{{ Fill Pkcs12 Description }} +### -Force +{{ Fill Force Description }} ```yaml Type: SwitchParameter -Parameter Sets: Pkcs12 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +{{ Fill Format Description }} + +```yaml +Type: String +Parameter Sets: Format +Aliases: +Accepted values: PKCS8, PKCS12 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PKCS12 +{{ Fill PKCS12 Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: PKCS12 Aliases: Required: True @@ -82,12 +120,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Pkcs8 -{{ Fill Pkcs8 Description }} +### -PKCS8 +{{ Fill PKCS8 Description }} ```yaml Type: SwitchParameter -Parameter Sets: Pkcs8 +Parameter Sets: PKCS8 Aliases: Required: True @@ -102,7 +140,7 @@ Accept wildcard characters: False ```yaml Type: PSObject -Parameter Sets: (All) +Parameter Sets: PKCS8, PKCS12 Aliases: Required: True @@ -112,6 +150,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PrivateKeyPasswordCredential +{{ Fill PrivateKeyPasswordCredential Description }} + +```yaml +Type: PSCredential +Parameter Sets: Format +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -ThrottleLimit {{ Fill ThrottleLimit Description }} @@ -163,6 +216,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### System.String +### System.Management.Automation.PSCredential ## OUTPUTS ### System.Object diff --git a/docs/functions/Invoke-VenafiRestMethod.md b/docs/functions/Invoke-VenafiRestMethod.md index f661a57b..5cbdeaa2 100644 --- a/docs/functions/Invoke-VenafiRestMethod.md +++ b/docs/functions/Invoke-VenafiRestMethod.md @@ -7,7 +7,7 @@ Ability to execute REST API calls which don't exist in a dedicated function yet ### Session (Default) ``` -Invoke-VenafiRestMethod [-VenafiSession ] [-Method ] [-UriRoot ] -UriLeaf +Invoke-VenafiRestMethod [-VenafiSession ] [-Method ] [-UriRoot ] [-UriLeaf ] [-Header ] [-Body ] [-FullResponse] [-TimeoutSec ] [-SkipCertificateCheck] [-ProgressAction ] [] ``` @@ -15,7 +15,7 @@ Invoke-VenafiRestMethod [-VenafiSession ] [-Method ] [-UriRoot ### URL ``` Invoke-VenafiRestMethod -Server [-UseDefaultCredential] [-Certificate ] - [-Method ] [-UriRoot ] -UriLeaf [-Header ] [-Body ] + [-Method ] [-UriRoot ] [-UriLeaf ] [-Header ] [-Body ] [-FullResponse] [-TimeoutSec ] [-SkipCertificateCheck] [-ProgressAction ] [] ``` @@ -140,7 +140,7 @@ Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/docs/functions/New-VcCertificate.md b/docs/functions/New-VcCertificate.md index de4e22b4..a36a0d17 100644 --- a/docs/functions/New-VcCertificate.md +++ b/docs/functions/New-VcCertificate.md @@ -260,7 +260,7 @@ Accept wildcard characters: False ### -ValidUntil Date at which the certificate becomes invalid. -Days and hours are supported, not minutes. +The day and hour will be set and not to the minute level. ```yaml Type: DateTime @@ -269,7 +269,7 @@ Aliases: Required: False Position: Named -Default value: (Get-Date).AddDays(90) +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/docs/functions/New-VcMachine.md b/docs/functions/New-VcMachine.md index 7d8323b8..9a638c74 100644 --- a/docs/functions/New-VcMachine.md +++ b/docs/functions/New-VcMachine.md @@ -9,14 +9,14 @@ ``` New-VcMachine -Name -MachineType -VSatellite -Owner [-Tag ] [-Status ] -ConnectionDetail -DekID [-NoVerify] [-ThrottleLimit ] - [-PassThru] [-VenafiSession ] [-ProgressAction ] [] + [-PassThru] [-Force] [-VenafiSession ] [-ProgressAction ] [] ``` ### BasicMachine ``` New-VcMachine -Name -MachineType [-VSatellite ] -Owner [-Tag ] [-Status ] [-Hostname ] -Credential [-Port ] [-NoVerify] - [-ThrottleLimit ] [-PassThru] [-VenafiSession ] [-ProgressAction ] + [-ThrottleLimit ] [-PassThru] [-Force] [-VenafiSession ] [-ProgressAction ] [] ``` @@ -79,6 +79,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Force +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Hostname {{ Fill Hostname Description }} diff --git a/docs/functions/New-VcMachineCommonKeystore.md b/docs/functions/New-VcMachineCommonKeystore.md index 71149cb7..a906a0ac 100644 --- a/docs/functions/New-VcMachineCommonKeystore.md +++ b/docs/functions/New-VcMachineCommonKeystore.md @@ -9,7 +9,7 @@ ``` New-VcMachineCommonKeystore -Name [-VSatellite ] -Owner [-Hostname ] -Credential [-Tag ] [-Status ] [-SshPassword] [-Port ] [-NoVerify] - [-ThrottleLimit ] [-PassThru] [-VenafiSession ] [-ProgressAction ] + [-ThrottleLimit ] [-PassThru] [-Force] [-VenafiSession ] [-ProgressAction ] [] ``` @@ -17,7 +17,7 @@ New-VcMachineCommonKeystore -Name [-VSatellite ] -Owner [-VSatellite ] -Owner [-Hostname ] -Credential [-Tag ] [-Status ] [-SshKey] [-Port ] [-NoVerify] - [-ThrottleLimit ] [-PassThru] [-VenafiSession ] [-ProgressAction ] + [-ThrottleLimit ] [-PassThru] [-Force] [-VenafiSession ] [-ProgressAction ] [] ``` @@ -25,7 +25,7 @@ New-VcMachineCommonKeystore -Name [-VSatellite ] -Owner [-VSatellite ] -Owner [-Hostname ] -Credential [-Tag ] [-Status ] [-WinrmBasic] [-Port ] [-UseTls] - [-SkipCertificateCheck] [-NoVerify] [-ThrottleLimit ] [-PassThru] [-VenafiSession ] + [-SkipCertificateCheck] [-NoVerify] [-ThrottleLimit ] [-PassThru] [-Force] [-VenafiSession ] [-ProgressAction ] [] ``` @@ -34,7 +34,7 @@ New-VcMachineCommonKeystore -Name [-VSatellite ] -Owner [-VSatellite ] -Owner [-Hostname ] -Credential [-Tag ] [-Status ] [-WinrmKerberos] [-Port ] [-UseTls] [-SkipCertificateCheck] -DomainName -KeyDistributionCenter -SPN [-NoVerify] - [-ThrottleLimit ] [-PassThru] [-VenafiSession ] [-ProgressAction ] + [-ThrottleLimit ] [-PassThru] [-Force] [-VenafiSession ] [-ProgressAction ] [] ``` @@ -82,6 +82,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Force +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Hostname {{ Fill Hostname Description }} diff --git a/docs/functions/New-VcMachineIis.md b/docs/functions/New-VcMachineIis.md index b024bf49..58339a9f 100644 --- a/docs/functions/New-VcMachineIis.md +++ b/docs/functions/New-VcMachineIis.md @@ -9,7 +9,7 @@ ``` New-VcMachineIis -Name [-VSatellite ] -Owner [-Hostname ] -Credential [-Tag ] [-Status ] [-Port ] [-UseTls] - [-SkipCertificateCheck] [-NoVerify] [-ThrottleLimit ] [-PassThru] [-VenafiSession ] + [-SkipCertificateCheck] [-NoVerify] [-ThrottleLimit ] [-PassThru] [-Force] [-VenafiSession ] [-ProgressAction ] [] ``` @@ -18,7 +18,7 @@ New-VcMachineIis -Name [-VSatellite ] -Owner [-Hostnam New-VcMachineIis -Name [-VSatellite ] -Owner [-Hostname ] -Credential [-Tag ] [-Status ] [-Port ] [-UseTls] [-SkipCertificateCheck] -DomainName -KeyDistributionCenter -SPN [-NoVerify] - [-ThrottleLimit ] [-PassThru] [-VenafiSession ] [-ProgressAction ] + [-ThrottleLimit ] [-PassThru] [-Force] [-VenafiSession ] [-ProgressAction ] [] ``` @@ -66,6 +66,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Force +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Hostname {{ Fill Hostname Description }} diff --git a/docs/functions/Set-VcCertificateRequest.md b/docs/functions/Set-VcCertificateRequest.md new file mode 100644 index 00000000..fe13c9be --- /dev/null +++ b/docs/functions/Set-VcCertificateRequest.md @@ -0,0 +1,194 @@ +# Set-VcCertificateRequest + +## SYNOPSIS +Update an existing application + +## SYNTAX + +``` +Set-VcCertificateRequest -ID [-Approve] [-Wait] [-PassThru] [-VenafiSession ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update details of existing applications. +Additional properties will be available in the future. + +## EXAMPLES + +### EXAMPLE 1 +``` +Set-VcCertificateRequest -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -Approve +``` + +Approve a request + +### EXAMPLE 2 +``` +Set-VcCertificateRequest -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -Approve:$false +``` + +Reject a request + +### EXAMPLE 3 +``` +Set-VcCertificateRequest -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -Approve -Wait +``` + +Approve a request and wait for the certificate request to finish processing + +### EXAMPLE 4 +``` +Set-VcCertificateRequest -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -Approve -Wait -PassThru +``` + +Approve a request and wait for the certificate request to finish processing. +Once finished, return the resulting object which contains the newly created certificate details. + +### EXAMPLE 5 +``` +Find-VcCertificateRequest -Status PENDING_APPROVAL | Set-VcCertificateRequest -Approve +``` + +Get all requests pending approval and approve them all. +Use the Find filter to narrow the scope of requests found. + +## PARAMETERS + +### -ID +{{ Fill ID Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: certificateRequestId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Approve +Provide the switch to approve a request + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Wait for the certificate request to either be issued or fail. +Depending on the speed of your CA, this could take some time. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the certificate request object. +If -Wait is specified, the returned object will have details on the newly created certificate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: Key + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### ID +## OUTPUTS + +### PSCustomObject +## NOTES + +## RELATED LINKS diff --git a/mkdocs.yml b/mkdocs.yml index 5eeb8696..b363f197 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,7 +27,6 @@ nav: - Home: index.md - Changelog: changelog.md - Functions: - - Add-VcCertificateAssociation: functions/Add-VcCertificateAssociation.md - Add-VcTeamMember: functions/Add-VcTeamMember.md - Add-VcTeamOwner: functions/Add-VcTeamOwner.md - Add-VdcAdaptableHash: functions/Add-VdcAdaptableHash.md @@ -131,6 +130,7 @@ nav: - Search-VdcHistory: functions/Search-VdcHistory.md - Set-VcApplication: functions/Set-VcApplication.md - Set-VcCertificate: functions/Set-VcCertificate.md + - Set-VcCertificateRequest: functions/Set-VcCertificateRequest.md - Set-VcConnector: functions/Set-VcConnector.md - Set-VcTeam: functions/Set-VcTeam.md - Set-VdcAttribute: functions/Set-VdcAttribute.md