Set-R1DirectoryAttribute
Set-R1DirectoryAttribute
SYNOPSIS
Updates an attribute in the directory schema.
SYNTAX
Set-R1DirectoryAttribute [-attribute] <String> [[-alias] <String[]>] [[-description] <String>]
[[-syntax] <String>] [[-multiValued] <Boolean>] [[-operational] <Boolean>] [[-isRequired] <Boolean>]
[[-isHiddenInLogs] <Boolean>] [[-objectclass] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates the definition of an attribute in the LDAP schema.
The current definition is retrieved before it is updated, and sent back with the supplied values applied over it, so a property left unspecified keeps its current value. The command therefore issues a GET followed by a PUT, and the account needs permission to read the definition as well as to change it.
EXAMPLES
Example 1
Set-R1DirectoryAttribute -attribute 'employeeShift' -multiValued $true
Makes employeeShift multi valued, leaving its other properties as they are.
PARAMETERS
-attribute
The name of the attribute.
Type: String
Parameter Sets: (All)
Aliases: name
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-alias
Alternative names for the attribute.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-description
A description of the attribute.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-syntax
The LDAP syntax of the attribute. Get-R1DirectoryAttributeSyntax lists those the deployment supports.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-multiValued
Whether the attribute may hold more than one value.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-operational
Whether the attribute is operational, and so not returned unless asked for by name.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-isRequired
Whether the attribute is required.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-isHiddenInLogs
Whether the value of the attribute is hidden in the logs.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-objectclass
The object class the attribute belongs to.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: True (ByPropertyName)
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
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.
INPUTS
None
OUTPUTS
System.Void
NOTES
The object identifier and whether the attribute is user generated are maintained by the server and cannot be changed here. They are sent back unaltered so that the update carries the complete definition.
A collection which is specified replaces the collection currently configured, rather than being added to it. Retrieve the current value, add to it and pass the result back to append.