Set-VdcAttribute¶

SYNOPSIS¶

Sets a value on an objects attribute or policies (policy attributes)

SYNTAX¶

NotPolicy (Default)¶

Set-VdcAttribute -Path <String> -Attribute <Hashtable> [-BypassValidation] [-NoOverwrite]
 [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Policy¶

Set-VdcAttribute -Path <String> -Attribute <Hashtable> -Class <String> [-Lock] [-BypassValidation]
 [-NoOverwrite] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION¶

Set the value on an objects attribute. The attribute can either be built-in or custom. You can also set policies (policy attributes).

EXAMPLES¶

EXAMPLE 1¶

Set-VdcAttribute -Path '\VED\Policy\My Folder\app.company.com' -Attribute @{'Consumers'='\VED\Policy\myappobject.company.com'}

Set the value on an object

EXAMPLE 2¶

Set-VdcAttribute -Path '\VED\Policy\My Folder\app.company.com' -Attribute @{'Management Type'=$null}

Clear the value on an object, reverting to policy if applicable

EXAMPLE 3¶

Set-VdcAttribute -Path '\VED\Policy\My Folder\app.company.com' -Attribute @{'My custom field Label'='new custom value'}

Set the value on a custom field

EXAMPLE 4¶

Set-VdcAttribute -Path '\VED\Policy\My Folder\app.company.com' -Attribute @{'My custom field Label'='new custom value'} -BypassValidation

Set the value on a custom field bypassing field validation

EXAMPLE 5¶

Set-VdcAttribute -Path '\VED\Policy\My Folder' -Class 'X509 Certificate' -Attribute @{'Notification Disabled'='0'}

Set a policy attribute

EXAMPLE 6¶

Set-VdcAttribute -Path '\VED\Policy\My Folder' -Class 'X509 Certificate' -Attribute @{'Notification Disabled'='0'} -Lock

Set a policy attribute and lock the value

EXAMPLE 7¶

Set-VdcAttribute -Path '\VED\Policy\app.company.com' -Attribute @{'X509 SubjectAltName IPAddress'='1.2.3.4'; 'X509 SubjectAltName DNS'='me.x.com'}

Update SAN field(s). The SAN key names are: - X509 SubjectAltName DNS - X509 SubjectAltName IPAddress - X509 SubjectAltName OtherName UPN - X509 SubjectAltName RFC822 - X509 SubjectAltName URI

PARAMETERS¶

-Path¶

Path to the object to modify

Type: String
Parameter Sets: (All)
Aliases: DN

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Attribute¶

Hashtable with names and values to be set. If setting a custom field, you can use either the name or guid as the key. If using a custom field name, you must have created a session with New-VenafiSession and not just a Certificate Manager, Self-Hosted token. To clear a value overwriting policy, set the value to $null.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Class¶

Required when setting policy attributes. Provide the class name to set the value for. If unsure of the class name, add the value through the Certificate Manager, Self-Hosted UI and go to Support->Policy Attributes to find it.

Type: String
Parameter Sets: Policy
Aliases: ClassName, PolicyClass

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Lock¶

Lock the value on the policy. Only applicable to setting policies.

Type: SwitchParameter
Parameter Sets: Policy
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-BypassValidation¶

Bypass data validation. Only applicable to custom fields.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-NoOverwrite¶

Add to any existing value, if there is one, as opposed to overwriting. Unlike overwriting, adding can only be a single value, not an array. Not applicable to custom fields.

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.

Type: PSObject
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: (Get-VenafiSession)
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf¶

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction¶

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.