Set-OVLdapGroupRole

Syntax

Set-OVLdapGroupRole
    [-InputObject] <Object>
    [-Roles] <Array>
    [-Append]
    [-UserName <String>]
    [-Password <System.Security.SecureString>]
    [-Credential <PSCredential>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

Set-OVLdapGroupRole
    [-InputObject] <Object>
    [-Roles] <Array>
    [-ScopePermissions] <Array>
    [-Append]
    [-UserName <String>]
    [-Password <System.Security.SecureString>]
    [-Credential <PSCredential>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

Set-OVLdapGroupRole
    [-InputObject] <Object>
    [-ScopePermissions] <Array>
    [-Append]
    [-UserName <String>]
    [-Password <System.Security.SecureString>]
    [-Credential <PSCredential>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

Description

Changes current roles of an LDAP Group with a given set of roles. You must provide the list of all roles the LDAP Group should be set to, and not a subset of roles.

Examples

Example 1

Set-OVLdapGroupRole -d Domain1 -GroupName "MY Directory Group1" -roles "Server administrator" -u "Sarah Peterson"

Add "MY Directory Group1" from Domain1 with Server Administrator role and prompt for password for group validation.

Example 2

$roles = "Server administrator","Backup administrator"
$password = ConvertTo-SecureString -asplaintext "password123890" -force
Set-OVLdapGroupRole -d Domain1 -GroupName "MY Directory Group1" -roles $roles -u "Sarah Peterson" -p $password

Set "MY Directory Group1" from Domain1 with Server and Backup administrator roles, and specify password for group validation.

Example 3

$LdapDirectoryName = "CorpDomain"
$MyAdCreds = Get-Credential
Get-OVLdapGroup -Group $CorpNetworkAdmins -ErrorAction Stop | ? loginDomain -eq $LdapDirectoryName | Set-OVLdapGroupRole -ScopePermissions @{Role = "Network administrator"; Scope = $NewSBACScope } -Credential $MyAdCreds

Change the Scope permissions for the specified authentication directory group.

Example 4

$scope = Get-OVScope -Name $scopename
$ScopePermissions = @{ Role = "Server administrator"; Scope = $scope
}
Get-OVLdapGroup -Name $scopename | Set-OVLdapGroupRole -ScopePermissions $ScopePermissions -Roles "Software administrator" -Credential $MyAdCreds

Change the Scope permissions for the specified authentication directory group by using both ScopePermissions and Roles parameters.

Parameters

-AuthProvider <String>

LDAP/Active Directory Domain Name

Aliases
Required?	True
Position?	Named
Default value
Accept pipeline input?
Accept wildcard characters?	False

-InputObject <Object>

Directroy Group to add.

Aliases	g, name, GroupName, Group
Required?	True
Position?	Named
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	False

-Roles <Array>

The role(s) to assign to the Directroy Group, in [System.Collections.ArrayList] format. Accepted values are noted within the ApplianceRoles property of the [HPEOneView.Appliance.Connection] object stored in the $Global:ConnectedSessions variable.

Example: $roles = "Server administrator","Network administrator"

Aliases	r, role
Required?	True
Position?	Named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-UserName <String>

Directory Username to authenticate with

Aliases	u
Required?	True
Position?	Named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Password <System.Security.SecureString>

Directory User account password

Aliases	p
Required?	True
Position?	Named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-ApplianceConnection <Object>

Specify one or more [HPEOneView.Appliance.Connection] object(s) or Name property value(s).

Aliases	Appliance
Required?	True
Position?	Named
Default value	(${Global:ConnectedSessions} | ? Default)
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	False

-Credential <PSCredential>

Use this parameter if you want to provide a PSCredential object instead.

Aliases	None
Required?	False
Position?	Named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-ScopePermissions <Array>

Array collection of Hashtable. Will overwrite existing scope to role mappings. To indiate all resouroures, use 'All' as the value.

Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-OVScope -Name CorpNetAdmins -ErrorAction Stop) }

Aliases	None
Required?	False
Position?	Named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Append <SwitchParameter>

Use to append roles and/or scope permissions update. If omitted, roles or scope permissions will be replaced.

Aliases	None
Required?	False
Position?	Named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

System.Security.SecureString

Directory User Account password

Return Values

System.Management.Automation.PSCustomObject

Updated LDAP Group object with new role assignment(s)

Related Links