Set-QARSAccessTemplateLink
From PowerGUI Wiki
Make changes to existing links of ActiveRoles Server Access Templates. This cmdlet requires a connection to be established to the ActiveRoles Server Administration Service by supplying the Proxy parameter.
Contents |
Syntax
Set-QARSAccessTemplateLink [-Identity] <IdentityParameter> [-ObjectAttributes <Object>] [-AccessTemplate <IdentityParameter>] [-Trustee <IdentityParameter>] [-Description <String>] [-AppliedTo <ATLinkFlags>] [-SynchronizedToAD [<Boolean>]] [-Disabled] [-Enabled] [-Proxy] [-Service <String>] [-ConnectionAccount <String>] [-ConnectionPassword <SecureString>] [-Credential <PSCredential>] [-Connection <ArsConnection>] [-UseGlobalCatalog] [-WhatIf] [-Confirm] [<CommonParameters>]
Detailed Description
Use this cmdlet to modify existing links of Access Templates in ActiveRoles Server. This cmdlet takes Access Template links returned by the respective Get- cmdlet, makes changes to the link data, and commits the changes to ActiveRoles Server. Each Access Template link contains information on how a certain Access Template is applied to determine access rights of a certain security principal (Trustee) on a certain directory object (securable object). For background information about Access Templates, see ActiveRoles Server Administrator Guide.
The cmdlet has optional parameters that determine the server and the security context for the operation. The connection parameters could be omitted since a connection to a server is normally established prior to using this cmdlet. In this case, the server and the security context are determined by the Connect-QADService cmdlet.
If you do not use Connect-QADService and have no connection established prior to using a cmdlet, then the connection settings, including the server and the security context, are determined by the connection parameters of the first cmdlet you use. Subsequent cmdlets will use those settings by default.
Note that this cmdlet requires a connection to the ActiveRoles Server Administration Service, so the Proxy parameter must be used to establish a connection.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Identity | You can specify the name, canonical name, or distinguished name (DN) of the link to modify (so as to identify the respective object located in the 'Configuration/AT Links' container in the ActiveRoles Server Configuration namespace).
Normally, pipelining is used to identify links: pass the output of the appropriate Get- cmdlet to this cmdlet. If you do so, the Identity parameter is not to be supplied on the command line. | true | true (ByValue) | |
| ObjectAttributes | Optionally, specify an associative array that defines the Access Template link attributes to set. The array syntax:
@{attr1='val1';attr2='val2';...} In this syntax, each of the key-value pairs is the LDAP display name and the value of an attribute to set. For information about associative arrays, type the following command at the PowerShell command-prompt: help about_associative_array | false | false | |
| AccessTemplate | Specify the identity (such as name, distinguished name, etc.) of an Access Template you want. The cmdlet configures the given link(s) to apply that Access Template. | false | false | |
| Trustee | Specify the identity (such as name, distinguished name, domain\name, etc.) of a security principal object (such as a user or group) you want. The cmdlet configures the given link(s) to determine access rights of that security principal (set the specified object as Trustee). | false | false | |
| Description | Set or clear the 'Description' attribute on the given link or links. | false | false | |
| AppliedTo | Set permission inheritance options on the given link or links. Valid parameter values are:
'This' - Indicates no inheritance. The Access Template link information is only used on the object to which the Access Template is applied. Access Template link information is not inherited by any descendents of the object. 'ThisObjectAndAllChildObjects' - Indicates inheritance that includes the object to which the Access Template is applied, the object's immediate children, and the descendents of the object's children. 'ThisObjectAndImmediateChildObjects' - Indicates inheritance that includes the object itself and its immediate children. It does not include the descendents of its children. 'AllChildObjects' - Indicates inheritance that includes the object's immediate children and the descendants of the object's children, but not the object itself. 'ImmediateChildObjects' - Indicates inheritance that includes the object's immediate children only, not the object itself or the descendents of its children. | false | false | |
| SynchronizedToAD | Set the value of this parameter to 'true' for the cmdlet to configure the given link(s) so as to propagate permission settings to Active Directory. If you want the cmdlet to disable the propagation of the permission settings that result from the given link(s), set the value of this parameter to 'false'. | false | false | |
| Disabled | Supply this parameter for the cmdlet to configure the given link(s) to have no effect in ActiveRoles Server (disabled links). If a given link is already disabled, this parameter does not take effect on that link. | false | false | |
| Enabled | Supply this parameter for the cmdlet to configure the given link(s) to have effect in ActiveRoles Server (enabled links). If a given link is already enabled, this parameter does not take effect on that link. | false | false | |
| Proxy | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Service | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| ConnectionAccount | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| ConnectionPassword | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Credential | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Connection | For parameter description, see help on the Connect-QADService cmdlet. | false | true (ByValue) | |
| UseGlobalCatalog | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| WhatIf | Describes what would happen if you executed the command, without actually executing the command. | false | false | |
| Confirm | Prompts you for confirmation before executing the command. | false | false |
Examples
Example 1
connect-QADService -Proxy C:\PS>get-QARSAccessTemplateLink -DirectoryObject 'Configuration/Managed Units/ManagedUnitName' -Predefined $false | set-QARSAccessTemplateLink -Trustee 'DomainName\GroupName' | out-Null
Connect to any available Administration Service. Then, for every Access Template link on a given ActiveRoles Server Managed Unit, set a given group as Trustee. This ensures that only members of that group have access to that Managed Unit in ActiveRoles Server.
Example 2
connect-QADService -Proxy
C:\PS>get-QADObject 'OrganizationalUnitName' -Type organizationalUnit | %{get-QARSAccessTemplateLink -AccessTemplate 'AccessTemplateName' -DirectoryObject $_ -Predefined $false} | set-QARSAccessTemplateLink -SynchronizedToAD $true -AppliedTo 'ThisObjectAndAllChildObjects' | out-Null
For a given organizational unit (OU) and a given Access Template applied on that OU, ensure that the permission settings defined by the Access Template on any object held in the OU are synchronized to Active Directory (on the respective Access Template link, enable the options to synchronize permission settings to AD and to apply them on both the OU and all child objects).
Example 3
connect-QADService -Proxy
C:\PS>get-QADObject -SearchRoot 'OrganizationalUnitName' | %{get-QARSAccessTemplateLink -AccessTemplate 'AccessTemplateName' -DirectoryObject $_ -SynchronizedToAD $true -Predefined $false} | set-QARSAccessTemplateLink -SynchronizedToAD $false | out-Null
For a given organizational unit (OU) and a given Access Template, ensure that the permission settings defined by the Access Template on any object held in the OU are not synchronized to Active Directory (disable the permission synchronization option for each link that is based on that Access Template and applied to any object held in that OU).
