Publish-QARSGroup
From PowerGUI Wiki
Publish a group to ActiveRoles Self-Service Manager. Publishing a group enables self-service users to submit requests to join or leave that group.
This cmdlet is part of the Quest ActiveRoles Server product. Use Get-QARSProductInfo to view information about ActiveRoles Server.
Contents |
Syntax
Publish-QARSGroup [-Identity] <IdentityParameter> [-Connection <ArsConnection>] [-ConnectionAccount <string>] [-ConnectionPassword <SecureString>] [-Control <hashtable>] [-Credential <PSCredential>] [-Keywords <UpdateStringParameter[]>] [-Proxy] [-RequireManagerApproval <Boolean>] [-RequireSecondaryOwnerApproval <Boolean>] [-Service <string>] [-UseGlobalCatalog] [-Confirm] [-WhatIf] [<CommonParameters>]
Detailed Description
Use this cmdlet to publish groups to ActiveRoles Self-Service Manager. By publishing a group you provide end-users with controlled access to their group memberships through the Self-Service Manager Web Interface. Publishing a group makes the group joinable by other people based on owner approval. Self-Service Manager enables users to submit requests to join or leave published groups, while ensuring that requests are granted only after approval by group owners.
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.
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Connection | 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 | |
| Control | Use this parameter to pass request controls (in-controls) to ActiveRoles Server as part of an operation request. In ActiveRoles Server, request controls are used to send extra information along with an operation request, to control how ActiveRoles Server performs the request.
The parameter value is a hash table that defines the names and values of the request controls to be passed to ActiveRoles Server. The parameter syntax is as follows: -Control @{<name> = <value>; [<name> = <value>] ...}
In this syntax, each of the name-value pairs is the name and the value of a single control. For instructions on how to create and use hash tables, see topic "about_associative_array" or "about_hash_tables" in Windows PowerShell Help. For information about ActiveRoles Server request controls, refer to ActiveRoles Server SDK documentation. Note that this parameter only has an effect on the operations that are performed through ActiveRoles Server (connection established using the Proxy parameter); otherwise, this parameter causes an error condition in ActiveRoles Management Shell. | false | false | |
| Credential | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Identity | Specify the Distinguished Name (DN), Canonical Name, GUID, Domain\Name, UPN or SID of the group to publish. The cmdlet publishes the specified group to ActiveRoles Self-Service Manager. When you pipe an object into the cmdlet, this parameter is used to receive the object. | true | true (ByValue) | |
| Keywords | Use this parameter to supply keywords for the group. Keywords are words or phrases that could help users find the group in ActiveRoles Server client applications, such as ActiveRoles Self-Service Manager. Parameter value can be a string array or an associative array that specifies one or more keywords to assign to the group or remove from the group. Some examples of possible parameter values are:
-Keywords 'keyword 1','keyword 2' Replace all the existing keywords with the keywords specified. -Keywords @{append=@('keyword 1','keyword 2')} Add the specified keywords without removing the existing keywords. -Keywords @{delete=@('keyword 1','keyword 2')} Remove the specified keywords, leaving the other keywords intact. -Keywords $null Remove all the existing keywords. | false | false | |
| Proxy | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| RequireManagerApproval | Use this parameter to specify whether user requests to join or leave the group require approval by the primary owner (manager) of the group. | false | false | |
| RequireSecondaryOwnerApproval | Use this parameter to specify whether user requests to join or leave the group require approval by a secondary owner of the group. | false | false | |
| Service | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| UseGlobalCatalog | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Confirm | Prompts you for confirmation before executing the command. | false | false | |
| WhatIf | Describes what would happen if you executed the command without actually executing the command. | false | false |
Examples
EXAMPLE 1
Publish-QARSGroup 'DomainName\GroupName' -RequireManagerApproval -Proxy
Description
Publish a group so that the user requests to join or leave the group require approval by the manager of the group.
EXAMPLE 2
Publish-QARSGroup 'DomainName\GroupName' -Keywords @{append=@('Published for Self-Service')} -RequireManagerApproval -Proxy
Description
When publishing a group, add the "Published for Self-Service" expression to the list of keywords on that group.
