From a5b4d21dc0e0bbb9536e5f12760575e6b359ab7a Mon Sep 17 00:00:00 2001 From: Greg Brownstein Date: Mon, 31 Oct 2022 20:12:37 +0000 Subject: [PATCH] Update manifest and docs to 5.2.0 --- CHANGELOG.md | 19 ++ VenafiPS/VenafiPS.psd1 | 4 +- docs/changelog.md | 19 ++ docs/functions/Add-TppAdaptableHash.md | 6 +- docs/functions/Export-VenafiCertificate.md | 11 +- docs/functions/Find-VaasObject.md | 198 +++++++++++++++++++++ docs/functions/Find-VenafiCertificate.md | 44 ++++- docs/functions/Get-VenafiCertificate.md | 2 +- docs/functions/Get-VenafiIdentity.md | 2 +- docs/functions/New-TppObject.md | 41 ++++- docs/functions/New-TppPolicy.md | 181 +++++++++++++++++-- docs/functions/New-VaasApplication.md | 15 +- docs/functions/Remove-TppEngineFolder.md | 4 +- docs/functions/Set-TppAttribute.md | 36 ++-- mkdocs.yml | 1 + 15 files changed, 513 insertions(+), 70 deletions(-) create mode 100644 docs/functions/Find-VaasObject.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 34da828d..27414ba1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,21 @@ +## 5.2.0 +- Add `Find-VaasObject` to search for ActivityLog, Machine, MachineIdentity, CertificateRequest, and CertificateInstance +- Add `-IssueDateBefore` and `IssueDateAfter` to `Find-VenafiCertificate` for TPP +- Add `New-TppObject -Force` to create missing parent policy folders +- Supercharge New-TppPolicy + - Add `-Name` to provide a list of policy folders to create + - Add `-Attribute` and `-PolicyAttribute` to set both kinds of attributes at policy creation time + - Add `-Force` to create missing parent policy folders +- Update messaging for `Export-VenafiCertificate` when using parameters for the wrong platform, [#149](https://github.com/Venafi/VenafiPS/issues/149) +- Update `New-VaasApplication -Owner` to accept a name in addition to guid +- Update VaaS searching to be aware of fields/values case sensitivity and adjust where needed. Eg., certificatestatus as opposed to certificateStatus. +- Fix `Find-TppObject` parameter sets to disallow -Recursive when -Path not provided, [#153](https://github.com/Venafi/VenafiPS/issues/153) +- Fix `Find-VenafiCertificate -Issuer` not working due to missing quotes, [#146](https://github.com/Venafi/VenafiPS/issues/146) +- Fix `Invoke-VenafiRestMethod -FullResponse` consuming certain errors instead of throwing them, [#152](https://github.com/Venafi/VenafiPS/issues/152) +- Fix `Get-VaasIssuingTemplate -All` not executing under certain circumstances + + + ## 5.1.1 - Minor bugfix @@ -455,5 +473,6 @@ + diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1 index 6245aa1c..b435a446 100644 --- a/VenafiPS/VenafiPS.psd1 +++ b/VenafiPS/VenafiPS.psd1 @@ -3,7 +3,7 @@ # # Generated by: Venafi # -# Generated on: 09/30/2022 +# Generated on: 10/31/2022 # @{ @@ -12,7 +12,7 @@ RootModule = 'VenafiPS.psm1' # Version number of this module. -ModuleVersion = '5.2' +ModuleVersion = '5.2.0' # Supported PSEditions # CompatiblePSEditions = @() diff --git a/docs/changelog.md b/docs/changelog.md index facf69b3..99f1126b 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,21 @@ +## 5.2.0 +- Add `Find-VaasObject` to search for ActivityLog, Machine, MachineIdentity, CertificateRequest, and CertificateInstance +- Add `-IssueDateBefore` and `IssueDateAfter` to `Find-VenafiCertificate` for TPP +- Add `New-TppObject -Force` to create missing parent policy folders +- Supercharge New-TppPolicy + - Add `-Name` to provide a list of policy folders to create + - Add `-Attribute` and `-PolicyAttribute` to set both kinds of attributes at policy creation time + - Add `-Force` to create missing parent policy folders +- Update messaging for `Export-VenafiCertificate` when using parameters for the wrong platform, [#149](https://github.com/Venafi/VenafiPS/issues/149) +- Update `New-VaasApplication -Owner` to accept a name in addition to guid +- Update VaaS searching to be aware of fields/values case sensitivity and adjust where needed. Eg., certificatestatus as opposed to certificateStatus. +- Fix `Find-TppObject` parameter sets to disallow -Recursive when -Path not provided, [#153](https://github.com/Venafi/VenafiPS/issues/153) +- Fix `Find-VenafiCertificate -Issuer` not working due to missing quotes, [#146](https://github.com/Venafi/VenafiPS/issues/146) +- Fix `Invoke-VenafiRestMethod -FullResponse` consuming certain errors instead of throwing them, [#152](https://github.com/Venafi/VenafiPS/issues/152) +- Fix `Get-VaasIssuingTemplate -All` not executing under certain circumstances + + + ## 5.1.1 - Minor bugfix @@ -455,5 +473,6 @@ + diff --git a/docs/functions/Add-TppAdaptableHash.md b/docs/functions/Add-TppAdaptableHash.md index ac8134ef..3a214344 100644 --- a/docs/functions/Add-TppAdaptableHash.md +++ b/docs/functions/Add-TppAdaptableHash.md @@ -16,7 +16,7 @@ This is referenced by the Attribute 'PowerShell Script Hash Vault Id' on the DN of the adaptable script. This script retrieves the hash (if present) from the Secret Store and compares it to the hash of the file in one of the scripts directories. -It then adds +It then adds a new or updated hash if required. When updating an existing hash, it removes the old one from the Secret Store. @@ -78,7 +78,7 @@ Accept wildcard characters: False ### -FilePath Required. The full path to the adaptable script file. -This should normally be in a +This should normally be in a '\:\Program Files\Venafi\Scripts\\\' directory for TPP to recognize the script. ```yaml @@ -96,7 +96,7 @@ Accept wildcard characters: False ### -VenafiSession Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. -A TPP token or VaaS key can also provided. +A TPP token can also provided. If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml diff --git a/docs/functions/Export-VenafiCertificate.md b/docs/functions/Export-VenafiCertificate.md index b8c4b38c..91e1d2a0 100644 --- a/docs/functions/Export-VenafiCertificate.md +++ b/docs/functions/Export-VenafiCertificate.md @@ -5,7 +5,7 @@ Get certificate data ## SYNTAX -### Vaas (Default) +### All (Default) ``` Export-VenafiCertificate -CertificateId -Format [-VenafiSession ] [] @@ -20,7 +20,7 @@ Export-VenafiCertificate -CertificateId -Format [-OutPath -Format [-IncludeChain] -FriendlyName +Export-VenafiCertificate -CertificateId [-IncludeChain] -FriendlyName [-PrivateKeyPassword ] -KeystorePassword [-VenafiSession ] [] ``` @@ -82,11 +82,11 @@ Accept wildcard characters: False ### -Format Certificate format. For Venafi as a Service, you can provide either PEM, DER, or JKS. -For TPP, Base64, Base64 (PKCS#8), DER, JKS, PKCS #7, or PKCS #12. +For TPP, you can provide Base64, Base64 (PKCS#8), DER, JKS, PKCS #7, or PKCS #12. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: All, Tpp Aliases: Required: True @@ -162,7 +162,8 @@ Accept wildcard characters: False ### -IncludePrivateKey DEPRECATED. -Provide a value for -PrivateKeyPassword. +Provide a value for -PrivateKeyPassword. +TPP only. ```yaml Type: SwitchParameter diff --git a/docs/functions/Find-VaasObject.md b/docs/functions/Find-VaasObject.md new file mode 100644 index 00000000..971088c1 --- /dev/null +++ b/docs/functions/Find-VaasObject.md @@ -0,0 +1,198 @@ +# Find-VaasObject + +## SYNOPSIS +Find different objects on VaaS + +## SYNTAX + +``` +Find-VaasObject [-Type] [[-Filter] ] [[-Order] ] [[-VenafiSession] ] + [-IncludeTotalCount] [-Skip ] [-First ] [] +``` + +## DESCRIPTION +Find objects of type ActivityLog, Machine, MachineIdentity, CertificateRequest, CertificateInstance on VaaS. +Supports -First for page size and -IncludeTotalCount to retrieve all by paging. +The max page size is 1000. +To find certificate objects, use Find-VenafiCertificate. + +## EXAMPLES + +### EXAMPLE 1 +``` +Find-VaasObject -Type CertificateInstance +``` + +Get first 1000 records + +### EXAMPLE 2 +``` +Find-VaasObject -Type CertificateInstance -First 50 +``` + +Get first 50 records + +### EXAMPLE 3 +``` +Find-VaasObject -Type CertificateInstance -First 500 -IncludeTotalCount +``` + +Get all records paging 500 at a time + +### EXAMPLE 4 +``` +Find-VaasObject -Type ActivityLog -Filter @('activityType', 'eq', 'Notifications') -First 10 +``` + +Retrieve 10 records matching the field name + +### EXAMPLE 5 +``` +Find-VaasObject -Type ActivityLog -Filter @('activityType', 'eq', 'Notifications') -First 10 -Order @{'activityDate'='desc'} +``` + +Retrieve the most recent 10 records matching the field name + +### EXAMPLE 6 +``` +Find-VaasObject -Filter @('and', @('activityDate', 'gt', (get-date).AddMonths(-1)), @('or', @('userId', 'eq', 'ab0feb46-8df7-47e7-8da9-f47ab314f26a'), @('userId', 'eq', '933c28de-6352-46f3-bc12-bd96077e8eae'))) +``` + +Advanced filtering of results. +This filter will find log entries by 1 of 2 people within the last month. + +## PARAMETERS + +### -Type +Type of object to retrieve. +Can be ActivityLog, Machine, MachineIdentity, CertificateRequest, or CertificateInstance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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 @('operator', @(field, comparison operator, value), @(field2, comparison operator2, value2)). +Nested filters are supported. +For a complete list of comparison operators, see https://docs.venafi.cloud/api/about-api-search-operators/. + +```yaml +Type: ArrayList +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +Array of fields to order on. +For each item in the array, you can provide a field name by itself; this will default to ascending. +You can also provide a hashtable with the field name as the key and either asc or desc as the value. + +```yaml +Type: PSObject[] +Parameter Sets: (All) +Aliases: + +Required: False +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 VaaS key can also provided. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: $script:VenafiSession +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeTotalCount +Reports the total number of objects in the data set (an integer) followed by the selected objects. +If the cmdlet cannot determine the total count, it displays "Unknown total count." The integer has an Accuracy property that indicates the reliability of the total count value. +The value of Accuracy ranges from 0.0 to 1.0 where 0.0 means that the cmdlet could not count the objects, 1.0 means that the count is exact, and a value between 0.0 and 1.0 indicates an increasingly reliable estimate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the specified number of objects and then gets the remaining objects. +Enter the number of objects to skip. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Gets only the specified number of objects. +Enter the number of objects to get. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +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 + +## OUTPUTS + +### PSCustomObject +## NOTES + +## RELATED LINKS + +[http://VenafiPS.readthedocs.io/en/latest/functions/Find-VaasObject/](http://VenafiPS.readthedocs.io/en/latest/functions/Find-VaasObject/) + +[https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Find-VaasObject.ps1](https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Find-VaasObject.ps1) + diff --git a/docs/functions/Find-VenafiCertificate.md b/docs/functions/Find-VenafiCertificate.md index 0ad513d9..3d97800e 100644 --- a/docs/functions/Find-VenafiCertificate.md +++ b/docs/functions/Find-VenafiCertificate.md @@ -18,13 +18,13 @@ Find-VenafiCertificate [-Path ] [-Guid ] [-Recursive] [-Limit ] [-KeySizeLessThan ] [-Locale ] [-Organization ] [-OrganizationUnit ] [-State ] [-SanDns ] [-SanEmail ] [-SanIP ] [-SanUpn ] [-SanUri ] [-SerialNumber ] [-SignatureAlgorithm ] - [-Thumbprint ] [-IssueDate ] [-ExpireDate ] [-ExpireAfter ] - [-ExpireBefore ] [-Enabled] [-InError ] [-NetworkValidationEnabled ] - [-CreatedDate ] [-CreatedAfter ] [-CreatedBefore ] [-CertificateType ] - [-ManagementType ] [-PendingWorkflow] [-Stage ] - [-StageGreaterThan ] [-StageLessThan ] [-ValidationEnabled] - [-ValidationState ] [-CountOnly] [-VenafiSession ] [-IncludeTotalCount] [-Skip ] - [-First ] [] + [-Thumbprint ] [-IssueDate ] [-IssueDateAfter ] [-IssueDateBefore ] + [-ExpireDate ] [-ExpireAfter ] [-ExpireBefore ] [-Enabled] [-InError ] + [-NetworkValidationEnabled ] [-CreatedDate ] [-CreatedAfter ] + [-CreatedBefore ] [-CertificateType ] [-ManagementType ] + [-PendingWorkflow] [-Stage ] [-StageGreaterThan ] + [-StageLessThan ] [-ValidationEnabled] [-ValidationState ] [-CountOnly] + [-VenafiSession ] [-IncludeTotalCount] [-Skip ] [-First ] [] ``` ### VaaS @@ -544,6 +544,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IssueDateAfter +{{ Fill IssueDateAfter Description }} + +```yaml +Type: DateTime +Parameter Sets: TPP +Aliases: ValidFromGreater + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IssueDateBefore +{{ Fill IssueDateBefore Description }} + +```yaml +Type: DateTime +Parameter Sets: TPP +Aliases: ValidFromLess + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExpireDate Find certificates by expiration date. TPP only. diff --git a/docs/functions/Get-VenafiCertificate.md b/docs/functions/Get-VenafiCertificate.md index c54a9eb0..e809a074 100644 --- a/docs/functions/Get-VenafiCertificate.md +++ b/docs/functions/Get-VenafiCertificate.md @@ -96,7 +96,7 @@ For TPP, use the path or guid. ```yaml Type: String Parameter Sets: Id, TppId, VaasId -Aliases: Guid, Path +Aliases: Guid, Path, id Required: True Position: Named diff --git a/docs/functions/Get-VenafiIdentity.md b/docs/functions/Get-VenafiIdentity.md index ed00c2c7..ca202d47 100644 --- a/docs/functions/Get-VenafiIdentity.md +++ b/docs/functions/Get-VenafiIdentity.md @@ -196,7 +196,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Members (if -IncludeMembers provided) ### For VaaS: ### username -### id +### userId ### companyId ### firstname ### lastname diff --git a/docs/functions/New-TppObject.md b/docs/functions/New-TppObject.md index dcb4cfb8..a8b8cde5 100644 --- a/docs/functions/New-TppObject.md +++ b/docs/functions/New-TppObject.md @@ -6,8 +6,8 @@ Create a new object ## SYNTAX ``` -New-TppObject [-Path] [-Class] [[-Attribute] ] [-PushCertificate] [-PassThru] - [[-VenafiSession] ] [-WhatIf] [-Confirm] [] +New-TppObject [-Path] [-Class] [[-Attribute] ] [-PushCertificate] [-Force] + [-PassThru] [[-VenafiSession] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -18,25 +18,36 @@ Generic use function to create a new object if a specific function hasn't been c ### EXAMPLE 1 ``` New-TppObject -Path '\VED\Policy\Test Device' -Class 'Device' -Attribute @{'Description'='new device testing'} -Create a new device ``` +Create a new object + ### EXAMPLE 2 ``` -New-TppObject -Path '\VED\Policy\Test Device' -Class 'Device' -Attribute @{'Description'='new device testing'} -PassThru -Create a new device and return the resultant object +New-TppObject -Path 'missing\folder\again' -Class 'Policy' -Force ``` +Create a new object as well as any missing policy folders in the path + ### EXAMPLE 3 ``` +New-TppObject -Path '\VED\Policy\Test Device' -Class 'Device' -Attribute @{'Description'='new device testing'} -PassThru +``` + +Create a new object and return the resultant object + +### EXAMPLE 4 +``` New-TppObject -Path '\VED\Policy\Test Device\App' -Class 'Basic' -Attribute @{'Driver Name'='appbasic';'Certificate'='\Ved\Policy\mycert.com'} -Create a new Basic application and associate it to a device and certificate ``` +Create a new Basic application and associate it to a device and certificate + ## PARAMETERS ### -Path Full path, including name, for the object to be created. +If the root path is excluded, \ved\policy will be prepended. ```yaml Type: String @@ -85,7 +96,6 @@ Accept wildcard characters: False ### -PushCertificate If creating an application object, you can optionally push the certificate once the creation is complete. Only available if a 'Certificate' key containing the certificate path is provided for Attribute. -Please note, this feature was added in v18.3. ```yaml Type: SwitchParameter @@ -99,6 +109,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force +Force the creation of missing parent policy folders when the class is either Policy or Device. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru Return a TppObject representing the newly created object. @@ -117,7 +142,7 @@ Accept wildcard characters: False ### -VenafiSession Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. -A TPP token or VaaS key can also provided. +A TPP token can also provided. If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml diff --git a/docs/functions/New-TppPolicy.md b/docs/functions/New-TppPolicy.md index 983e343e..e79c68c8 100644 --- a/docs/functions/New-TppPolicy.md +++ b/docs/functions/New-TppPolicy.md @@ -5,60 +5,211 @@ Add a new policy folder ## SYNTAX +### NameWithPolicyAttribute ``` -New-TppPolicy [-Path] [[-Description] ] [-PassThru] [[-VenafiSession] ] [-WhatIf] - [-Confirm] [] +New-TppPolicy -Path -Name -Attribute -Class [-Lock] [-Force] + [-PassThru] [-VenafiSession ] [-WhatIf] [-Confirm] [] +``` + +### PathWithPolicyAttribute +``` +New-TppPolicy -Path -Attribute -Class [-Lock] [-Force] [-PassThru] + [-VenafiSession ] [-WhatIf] [-Confirm] [] +``` + +### Name +``` +New-TppPolicy -Path -Name [-Description ] [-Attribute ] [-Force] + [-PassThru] [-VenafiSession ] [-WhatIf] [-Confirm] [] +``` + +### Path +``` +New-TppPolicy -Path [-Description ] [-Attribute ] [-Force] [-PassThru] + [-VenafiSession ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Add a new policy folder +Add a new policy folder(s). +Add object attributes or policy attributes at the same time. ## EXAMPLES ### EXAMPLE 1 ``` -$newPolicy = New-TppPolicy -Path '\VED\Policy\Existing Policy Folder\New Policy Folder' -PassThru -Create policy returning the policy object created +$newPolicy = New-TppPolicy -Path 'new' ``` +Create a new policy folder + ### EXAMPLE 2 ``` -New-TppPolicy -Path '\VED\Policy\Existing Policy Folder\New Policy Folder' -Description 'this is awesome' -Create policy with description +$newPolicy = New-TppPolicy -Path 'existing' -Name 'new1', 'new2', 'new3' +``` + +Create multiple policy folders + +### EXAMPLE 3 +``` +$newPolicy = New-TppPolicy -Path 'new1\new2\new3' -Force +``` + +Create a new policy folder named new3 and create new1 and new2 if they do not exist + +### EXAMPLE 4 +``` +$newPolicy = New-TppPolicy -Path 'new' -Attribute {'Description'='my new policy folder'} +``` + +Create a new policy folder setting attributes on the object at creation time + +### EXAMPLE 5 +``` +$newPolicy = New-TppPolicy -Path 'new' -Class 'X509 Certificate' -Attribute {'State'='UT'} +``` + +Create a new policy folder setting policy attributes (not object attributes) + +### EXAMPLE 6 +``` +$newPolicy = New-TppPolicy -Path 'new' -Class 'X509 Certificate' -Attribute {'State'='UT'} -Lock ``` +Create a new policy folder setting policy attributes (not object attributes) and locking them + +### EXAMPLE 7 +``` +$newPolicy = New-TppPolicy -Path 'new' -PassThru +``` + +Create a new policy folder returning the policy object created + ## PARAMETERS ### -Path -DN path to the new policy +Full path to the new policy folder. +If the root path is excluded, \ved\policy will be prepended. +If used with -Name, this will be the root path and subfolders will be created. ```yaml Type: String Parameter Sets: (All) -Aliases: PolicyDN +Aliases: Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +One of more policy folders to create under -Path. + +```yaml +Type: String[] +Parameter Sets: NameWithPolicyAttribute, Name +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False Accept wildcard characters: False ``` ### -Description -Policy description +Deprecated. +Use -Attribute @{''Description''=''my description''} instead. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Name, Path Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Attribute +Hashtable with names and values to be set on the policy itself. +If used with -Class, this will set policy attributes. +If setting a custom field, you can use either the name or guid as the key. +To clear a value overwriting policy, set the value to $null. + +```yaml +Type: Hashtable +Parameter Sets: NameWithPolicyAttribute, PathWithPolicyAttribute +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Hashtable +Parameter Sets: Name, Path +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Class +Use with -Attribute to set policy attributes at policy creation time. +If unsure of the class name, add the value through the TPP UI and go to Support-\>Policy Attributes to find it. + +```yaml +Type: String +Parameter Sets: NameWithPolicyAttribute, PathWithPolicyAttribute +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lock +Use with -PolicyAttribute and -Class to lock the policy attribute + +```yaml +Type: SwitchParameter +Parameter Sets: NameWithPolicyAttribute, PathWithPolicyAttribute +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force the creation of missing parent policy folders + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru Return a TppObject representing the newly created policy. @@ -86,7 +237,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 3 +Position: Named Default value: $script:VenafiSession Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/functions/New-VaasApplication.md b/docs/functions/New-VaasApplication.md index 35e78845..9670135b 100644 --- a/docs/functions/New-VaasApplication.md +++ b/docs/functions/New-VaasApplication.md @@ -7,28 +7,28 @@ Create a new application ### NoTarget (Default) ``` -New-VaasApplication -Name -Owner [-Description ] +New-VaasApplication -Name -Owner [-Description ] [-CertificateIssuingTemplate ] [-PassThru] [-VenafiSession ] [-WhatIf] [-Confirm] [] ``` ### FqdnIPRange ``` -New-VaasApplication -Name -Owner [-Description ] +New-VaasApplication -Name -Owner [-Description ] [-CertificateIssuingTemplate ] -Fqdn -IPRange -Port [-PassThru] [-VenafiSession ] [-WhatIf] [-Confirm] [] ``` ### Fqdn ``` -New-VaasApplication -Name -Owner [-Description ] +New-VaasApplication -Name -Owner [-Description ] [-CertificateIssuingTemplate ] -Fqdn -Port [-PassThru] [-VenafiSession ] [-WhatIf] [-Confirm] [] ``` ### IPRange ``` -New-VaasApplication -Name -Owner [-Description ] +New-VaasApplication -Name -Owner [-Description ] [-CertificateIssuingTemplate ] -IPRange -Port [-PassThru] [-VenafiSession ] [-WhatIf] [-Confirm] [] ``` @@ -40,7 +40,7 @@ Create a new application with optional details ### EXAMPLE 1 ``` -New-VaasApplication -Name 'MyNewApp' -Owner '4ba1e64f-12ad-4a34-a0e2-bc4481a56f7d' +New-VaasApplication -Name 'MyNewApp' -Owner '4ba1e64f-12ad-4a34-a0e2-bc4481a56f7d','greg@venafi.com' ``` Create a new application @@ -77,11 +77,10 @@ Accept wildcard characters: False ``` ### -Owner -List of user and/or team IDs to be owners. -Use Get-VenafiIdentity or Get-VenafiTeam to retrieve the ID. +List of user and/or team IDs or names to be owners ```yaml -Type: Guid[] +Type: String[] Parameter Sets: (All) Aliases: diff --git a/docs/functions/Remove-TppEngineFolder.md b/docs/functions/Remove-TppEngineFolder.md index ff5af8dc..0b0604ca 100644 --- a/docs/functions/Remove-TppEngineFolder.md +++ b/docs/functions/Remove-TppEngineFolder.md @@ -67,7 +67,7 @@ Aliases: FolderDN, Folder Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -82,7 +82,7 @@ Aliases: EngineDN, Engine Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/docs/functions/Set-TppAttribute.md b/docs/functions/Set-TppAttribute.md index 6c1ba04f..c2ead83c 100644 --- a/docs/functions/Set-TppAttribute.md +++ b/docs/functions/Set-TppAttribute.md @@ -13,7 +13,7 @@ Set-TppAttribute -Path -Attribute [-BypassValidation] [-Ven ### Policy ``` -Set-TppAttribute -Path -Attribute [-BypassValidation] -Class [-Lock] +Set-TppAttribute -Path -Attribute -Class [-Lock] [-BypassValidation] [-VenafiSession ] [-WhatIf] [-Confirm] [] ``` @@ -79,7 +79,7 @@ Aliases: DN Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -100,22 +100,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassValidation -Bypass data validation. -Only applicable to custom fields. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Class Required when setting policy attributes. Provide the class name to set the value for. @@ -149,6 +133,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -BypassValidation +Bypass data validation. +Only applicable to custom fields. + +```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. diff --git a/mkdocs.yml b/mkdocs.yml index b0f52b2c..c7d1a340 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,6 +44,7 @@ nav: - Find-TppIdentity: functions/Find-TppIdentity.md - Find-TppObject: functions/Find-TppObject.md - Find-TppVaultId: functions/Find-TppVaultId.md + - Find-VaasObject: functions/Find-VaasObject.md - Find-VenafiCertificate: functions/Find-VenafiCertificate.md - Get-TppAttribute: functions/Get-TppAttribute.md - Get-TppClassAttribute: functions/Get-TppClassAttribute.md