|
APIs in Category: Group |
API version 5.0 |
GroupAddMember |
These operations include everything necessary To manage DFM Groups. |
| GroupAddMember (supported) | [top] |
Add a member To a Group.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EINVALIDMEMBER - The proposed member object is not a groupable object Type. The Error message indicates which object.
- EMEMBERALREADYINGROUP - The proposed new member is already in the Group.
- EMEMBERNAMEAMBIGUOUS - The proposed member Name could refer To 2 or more Objects.
- EOBJECTNOTFOUND - The proposed member Name or ID was not found.
- EACCESSDENIED - The user does not have the Capability To add Members To the Group.
- EDATABASEERROR - A database Error occured.
Input Name Type GroupAddMember GroupAddMember
Output Name Type GroupAddMemberResult GroupAddMemberResult
Error Name Description EACCESSDENIED EDATABASEERROR EGROUPDOESNOTEXIST EINTERNALERROR EINVALIDMEMBER EMEMBERALREADYINGROUP EMEMBERNAMEAMBIGUOUS EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| GroupCopy (supported) | [top] |
Copy the Group and all of its subgroups under a new parent Group.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EGROUPEXISTS - An attempt was made To create a new Group with the same Name as an already existing Group. Try again with a different Name.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINVALIDGROUPNAME - The proposed Group Name was not valid.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EPARENTGROUPDOESNOTEXIST - The parent Group Name or ID was not found.
- EPARENTGROUPNAMEAMBIGUOUS - The specified parent Group Name could refer To 2 or more Groups. Try again with a parent Group ID or a fully qualified parent Group Name.
- EACCESSDENIED - The user does not have the Capability To copy the Group.
- EDATABASEERROR - A database Error occured.
Input Name Type GroupCopy GroupCopy
Output Name Type GroupCopyResult GroupCopyResult
Error Name Description EACCESSDENIED EDATABASEERROR EGROUPCOPYERROR EGROUPDOESNOTEXIST EGROUPEXISTS EINTERNALERROR EINVALIDGROUPNAME EOBJECTAMBIGUOUS EPARENTGROUPDOESNOTEXIST EPARENTGROUPNAMEAMBIGUOUS
| GroupCreate (supported) | [top] |
Create a new Group.
Error conditions:
- EGROUPEXISTS - An attempt was made To create a new Group with the same Name as an already existing Group. Try again with a different Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EINVALIDGROUPNAME - The proposed Group Name was not valid.
- EPARENTGROUPDOESNOTEXIST - The parent Group Name or ID was not found.
- EPARENTGROUPNAMEAMBIGUOUS - The specified parent Group Name could refer To 2 or more Groups. Try again with a parent Group ID or a fully qualified parent Group Name.
- EACCESSDENIED - The user does not have the Capability To create the Group.
- EDATABASEERROR - A database Error occured.
Input Name Type GroupCreate GroupCreate
Output Name Type GroupCreateResult GroupCreateResult
Error Name Description EACCESSDENIED EDATABASEERROR EGROUPEXISTS EINTERNALERROR EINVALIDGROUPNAME EPARENTGROUPDOESNOTEXIST EPARENTGROUPNAMEAMBIGUOUS
| GroupDeleteMember (supported) | [top] |
Remove one member From a Group.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EMEMBERNOTINGROUP - The object specified is not a member in the Group.
- EOBJECTNOTFOUND - The object specified was not found.
- EACCESSDENIED - The user does not have the Capability To delete Members From the Group.
- EDATABASEERROR - A database Error occured.
Input Name Type GroupDeleteMember GroupDeleteMember
Output Name Type GroupDeleteMemberResult GroupDeleteMemberResult
Error Name Description EACCESSDENIED EDATABASEERROR EGROUPDOESNOTEXIST EINTERNALERROR EMEMBERNOTINGROUP EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| GroupDestroy (supported) | [top] |
Destroy an existing Group. Child Groups are destroyed recursively. If there is any Error, then no Groups are destroyed.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EACCESSDENIED - The user does not have the Capability To Destroy the Group.
- EDATABASEERROR - A database Error occured.
Input Name Type GroupDestroy GroupDestroy
Output Name Type GroupDestroyResult GroupDestroyResult
Error Name Description EACCESSDENIED EDATABASEERROR EGROUPDOESNOTEXIST EINTERNALERROR EOBJECTAMBIGUOUS
| GroupGetOptions (supported) | [top] |
Get the Options for a Group. Option Values that are not present indicate that the Option is using the global default.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EACCESSDENIED - The user does not have the Capability To read Options of the Group.
- EDATABASEERROR - A database Error occured.
Input Name Type GroupGetOptions GroupGetOptions
Output Name Type GroupGetOptionsResult GroupGetOptionsResult
Error Name Description EACCESSDENIED EDATABASEERROR EGROUPDOESNOTEXIST EINTERNALERROR EOBJECTAMBIGUOUS
| GroupGetStatus (supported) | [top] |
Get the Status of the Group
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EACCESSDENIED - The user does not have the Capability To get the Status of the Group.
- EDATABASEERROR - A database Error occured.
Input Name Type GroupGetStatus GroupGetStatus
Output Name Type GroupGetStatusResult GroupGetStatusResult
Error Name Description EACCESSDENIED EDATABASEERROR EGROUPDOESNOTEXIST EINTERNALERROR EOBJECTAMBIGUOUS
| GroupIsMemberOf (supported) | [top] |
Checks if the object associated with the ObjectId input is a member of the Group. This includes both direct and indirect membership. If a Group Id of 0 is passed, this will always return true as long as the object is a valid object.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EMEMBERNAMEAMBIGUOUS - The proposed member Name could refer To 2 or more Objects.
- EOBJECTNOTFOUND - The object specified was not found.
- EACCESSDENIED - The user does not have the Capability To read From the database.
- EDATABASEERROR - A database Error occured.
Input Name Type GroupIsMemberOf GroupIsMemberOf
Output Name Type GroupIsMemberOfResult GroupIsMemberOfResult
Error Name Description EACCESSDENIED EDATABASEERROR EGROUPDOESNOTEXIST EINTERNALERROR EMEMBERNAMEAMBIGUOUS EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| GroupListIterEnd (supported) | [top] |
The GroupListIter* set of APIs are used To retrieve the Members of the DFM global Group. GroupListIterEnd is used To tell the DFM station that the temporary store used by DFM To support the GroupListIterNext API for the particular Tag is no longer necessary.
Error conditions:
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EINVALIDTAG - The iterator Tag specified is not valid. Restart the iteration Operation To obtain a new valid Tag.
Input Name Type GroupListIterEnd GroupListIterEnd
Output Name Type GroupListIterEndResult GroupListIterEndResult
Error Name Description EINTERNALERROR EINVALIDTAG
| GroupListIterNext (supported) | [top] |
For more documentation please check GroupListIterStart. The GroupListIterNext API is used To iterate over the Members of the Group stored in the temporary store created by the GroupListIterStart API.
Error conditions:
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EINVALIDTAG - The iterator Tag specified is not valid. Restart the iteration Operation To obtain a new valid Tag.
Input Name Type GroupListIterNext GroupListIterNext
Output Name Type GroupListIterNextResult GroupListIterNextResult
Error Name Description EINTERNALERROR EINVALIDTAG
| GroupListIterStart (supported) | [top] |
The GroupListIter* set of APIs are used To retrieve the list of DFM Groups. By default, a Group is listed if the user has DFM.Database.Read Capability on the Group or if the user has DFM.Database.Read Capability on any subgroup of the Group.
If RbacOperation is present in the input, then a Group is listed, if the authenticated user has the requested Capability on that Group or if the user has the required Capability on any of its sub-groups. In that case, HasPrivilege output will be false for the parent Group and true for the sub-group.
The GroupListIterStart API is used To load the list of Groups into a temporary store. The API returns a Tag that identifies that temporary store so that subsequent APIs can be used To iterate over the Groups in the temporary store.
If GroupListIterStart is invoked twice, then two distinct temporary stores are created.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - Specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EACCESSDENIED - The user does not have DFM.Database.Read or if RbacOperation is specified, the user does nat have the requested Capability on the specified Group.
- EDATABASEERROR - A database Error occured.
- ENOTFOUNDOPERATION - If the input element RbacOperation is not a valid RBAC Operation Name.
Input Name Type GroupListIterStart GroupListIterStart
Output Name Type GroupListIterStartResult GroupListIterStartResult
Error Name Description EACCESSDENIED EDATABASEERROR EGROUPDOESNOTEXIST EINTERNALERROR ENOTFOUNDOPERATION EOBJECTAMBIGUOUS
| GroupMove (supported) | [top] |
Move the Group under a new parent Group. The Id of the Group does not change after the move.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EGROUPEXISTS - An attempt was made To create a new Group with the same Name as an already existing Group. Try again with a different Name.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINVALIDGROUPNAME - The proposed Group Name was not valid.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EPARENTGROUPDOESNOTEXIST - The parent Group Name or ID was not found.
- EPARENTGROUPNAMEAMBIGUOUS - The specified parent Group Name could refer To 2 or more Groups. Try again with a parent Group ID or a fully qualified parent Group Name.
- EACCESSDENIED - The user does not have the Capability To move the Group.
- EDATABASEERROR - A database Error occured.
Input Name Type GroupMove GroupMove
Output Name Type GroupMoveResult GroupMoveResult
Error Name Description EACCESSDENIED EDATABASEERROR EGROUPDOESNOTEXIST EGROUPEXISTS EGROUPMOVEERROR EINTERNALERROR EINVALIDGROUPNAME EOBJECTAMBIGUOUS EPARENTGROUPDOESNOTEXIST EPARENTGROUPNAMEAMBIGUOUS
| GroupRename (supported) | [top] |
Change the Name of a Group.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EGROUPEXISTS - An attempt was made To create a new Group with the same Name as an already existing Group. Try again with a different Name.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EINVALIDGROUPNAME - The proposed Group Name was not valid.
- EACCESSDENIED - The user does not have the Capability To rename the Group.
- EDATABASEERROR - A database Error occured.
Input Name Type GroupRename GroupRename
Output Name Type GroupRenameResult GroupRenameResult
Error Name Description EACCESSDENIED EDATABASEERROR EGROUPDOESNOTEXIST EGROUPEXISTS EINTERNALERROR EINVALIDGROUPNAME EOBJECTAMBIGUOUS
| GroupSetOptions (supported) | [top] |
Change one or more Options for a Group. Only Options that are specified will be updated. The remaining Options will retain their current Values. If there is any Error, then no Options are changed.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EINVALIDINPUT - Invalid Value for one of the Options was specified.
- EACCESSDENIED - The user does not have the Capability To set Options for the Group.
- EDATABASEERROR - A database Error occured.
Input Name Type GroupSetOptions GroupSetOptions
Output Name Type GroupSetOptionsResult GroupSetOptionsResult
Error Name Description EACCESSDENIED EDATABASEERROR EGROUPDOESNOTEXIST EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS
| Element definition: GroupAddMember | [top] |
Add a member To a Group.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EINVALIDMEMBER - The proposed member object is not a groupable object Type. The Error message indicates which object.
- EMEMBERALREADYINGROUP - The proposed new member is already in the Group.
- EMEMBERNAMEAMBIGUOUS - The proposed member Name could refer To 2 or more Objects.
- EOBJECTNOTFOUND - The proposed member Name or ID was not found.
- EACCESSDENIED - The user does not have the Capability To add Members To the Group.
- EDATABASEERROR - A database Error occured.
Name Type Description GroupNameOrId GroupNameOrId
Name or ID of a Group. If a Group Name is specified, it must be fully qualified. MemberNameOrId ObjectNameOrId
Name or ID of a member To add To the Group.
| Element definition: GroupAddMemberResult | [top] |
[none]
| Element definition: GroupCopy | [top] |
Copy the Group and all of its subgroups under a new parent Group.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EGROUPEXISTS - An attempt was made To create a new Group with the same Name as an already existing Group. Try again with a different Name.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINVALIDGROUPNAME - The proposed Group Name was not valid.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EPARENTGROUPDOESNOTEXIST - The parent Group Name or ID was not found.
- EPARENTGROUPNAMEAMBIGUOUS - The specified parent Group Name could refer To 2 or more Groups. Try again with a parent Group ID or a fully qualified parent Group Name.
- EACCESSDENIED - The user does not have the Capability To copy the Group.
- EDATABASEERROR - A database Error occured.
Name Type Description GroupNameOrId GroupNameOrId
Name or ID of a Group. If a Group Name is specified, it must be fully qualified. NewGroupName xsd:string
optional
Group will be copied under the new parent Group with this Name. Groups may contain any printable ASCII character except slash characters. The Maximum Name Length is 64 characters. Group Name cannot be "global" or "all" or fully numeric. ParentGroupNameOrId GroupNameOrId
Name or ID of the new parent Group. If a Group Name is specified, it must be fully qualified.
| Element definition: GroupCopyResult | [top] |
Name Type Description GroupId xsd:integer
ID of the newly created copy.
Range: [1..2^31-1]
| Element definition: GroupCreate | [top] |
Create a new Group.
Error conditions:
- EGROUPEXISTS - An attempt was made To create a new Group with the same Name as an already existing Group. Try again with a different Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EINVALIDGROUPNAME - The proposed Group Name was not valid.
- EPARENTGROUPDOESNOTEXIST - The parent Group Name or ID was not found.
- EPARENTGROUPNAMEAMBIGUOUS - The specified parent Group Name could refer To 2 or more Groups. Try again with a parent Group ID or a fully qualified parent Group Name.
- EACCESSDENIED - The user does not have the Capability To create the Group.
- EDATABASEERROR - A database Error occured.
Name Type Description GroupName xsd:string
Name of the new Group. Groups may contain any printable ASCII character except slash characters. The Maximum Name Length is 64 characters. Group Name cannot be "all" or "global" or fully numeric. ParentGroupNameOrId GroupNameOrId
optional
Name or ID of the parent Group. If this Value is not specified, a new top-level Group is created. If a Group Name is specified, it must be fully qualified.
| Element definition: GroupCreateResult | [top] |
Name Type Description GroupId xsd:integer
ID of the newly created Group.
Range: [1..2^31-1]
| Element definition: GroupDeleteMember | [top] |
Remove one member From a Group.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EMEMBERNOTINGROUP - The object specified is not a member in the Group.
- EOBJECTNOTFOUND - The object specified was not found.
- EACCESSDENIED - The user does not have the Capability To delete Members From the Group.
- EDATABASEERROR - A database Error occured.
Name Type Description GroupNameOrId GroupNameOrId
Name or ID of a Group. If a Group Name is specified, it must be fully qualified. MemberNameOrId ObjectNameOrId
Name or ID of a member To remove From the Group.
| Element definition: GroupDeleteMemberResult | [top] |
[none]
| Element definition: GroupDestroy | [top] |
Destroy an existing Group. Child Groups are destroyed recursively. If there is any Error, then no Groups are destroyed.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EACCESSDENIED - The user does not have the Capability To Destroy the Group.
- EDATABASEERROR - A database Error occured.
Name Type Description GroupNameOrId GroupNameOrId
Name or ID of a Group To be destroyed. If a Group Name is specified, it must be fully qualified.
| Element definition: GroupDestroyResult | [top] |
[none]
| Element definition: GroupGetOptions | [top] |
Get the Options for a Group. Option Values that are not present indicate that the Option is using the global default.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EACCESSDENIED - The user does not have the Capability To read Options of the Group.
- EDATABASEERROR - A database Error occured.
Name Type Description GroupNameOrId GroupNameOrId
Name or ID of a Group. If a Group Name is specified, it must be fully qualified.
| Element definition: GroupGetOptionsResult | [top] |
Name Type Description GroupOptionInfo GroupOptionInfo
Name or ID of a Group. If a Group Name is specified, it must be fully qualified.
| Element definition: GroupGetStatus | [top] |
Get the Status of the Group
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EACCESSDENIED - The user does not have the Capability To get the Status of the Group.
- EDATABASEERROR - A database Error occured.
Name Type Description GroupNameOrId GroupNameOrId
Name or ID of a Group. If a Group Name is specified, it must be fully qualified.
| Element definition: GroupGetStatusResult | [top] |
Name Type Description GroupStatus ObjStatus
Current Status of the Group.
| Element definition: GroupIsMemberOf | [top] |
Checks if the object associated with the ObjectId input is a member of the Group. This includes both direct and indirect membership. If a Group Id of 0 is passed, this will always return true as long as the object is a valid object.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EMEMBERNAMEAMBIGUOUS - The proposed member Name could refer To 2 or more Objects.
- EOBJECTNOTFOUND - The object specified was not found.
- EACCESSDENIED - The user does not have the Capability To read From the database.
- EDATABASEERROR - A database Error occured.
Name Type Description GroupNameOrId GroupNameOrId
Name or ID of a Group. If a Group Name is specified, it must be fully qualified. ObjectNameOrId ObjectNameOrId
Name or ID of the object we want To determine if it is a member of the Group.
| Element definition: GroupIsMemberOfResult | [top] |
Name Type Description IsMember xsd:boolean
Returns true if the object associated with the ObjectId is a direct or indirect member of the Group.
| Element definition: GroupListIterEnd | [top] |
The GroupListIter* set of APIs are used To retrieve the Members of the DFM global Group. GroupListIterEnd is used To tell the DFM station that the temporary store used by DFM To support the GroupListIterNext API for the particular Tag is no longer necessary.
Error conditions:
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EINVALIDTAG - The iterator Tag specified is not valid. Restart the iteration Operation To obtain a new valid Tag.
Name Type Description Tag xsd:string
An internal opaque handle used by the DFM station
| Element definition: GroupListIterEndResult | [top] |
[none]
| Element definition: GroupListIterNext | [top] |
For more documentation please check GroupListIterStart. The GroupListIterNext API is used To iterate over the Members of the Group stored in the temporary store created by the GroupListIterStart API.
Error conditions:
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EINVALIDTAG - The iterator Tag specified is not valid. Restart the iteration Operation To obtain a new valid Tag.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve.
Range: [1..2^31-1]Tag xsd:string
Tag From a previous GroupListIterStart. It's an opaque handle used by the DFM station To identify the temporary store created by GroupListIterStart.
| Element definition: GroupListIterNextResult | [top] |
Name Type Description GroupList ArrayOfGroupInfo
An array of GroupInfo that describes each Group. Records xsd:integer
The number of Records actually returned as a Result of invoking this API.
Range: [1..2^31-1]
| Element definition: GroupListIterStart | [top] |
The GroupListIter* set of APIs are used To retrieve the list of DFM Groups. By default, a Group is listed if the user has DFM.Database.Read Capability on the Group or if the user has DFM.Database.Read Capability on any subgroup of the Group.
If RbacOperation is present in the input, then a Group is listed, if the authenticated user has the requested Capability on that Group or if the user has the required Capability on any of its sub-groups. In that case, HasPrivilege output will be false for the parent Group and true for the sub-group.
The GroupListIterStart API is used To load the list of Groups into a temporary store. The API returns a Tag that identifies that temporary store so that subsequent APIs can be used To iterate over the Groups in the temporary store.
If GroupListIterStart is invoked twice, then two distinct temporary stores are created.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - Specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EACCESSDENIED - The user does not have DFM.Database.Read or if RbacOperation is specified, the user does nat have the requested Capability on the specified Group.
- EDATABASEERROR - A database Error occured.
- ENOTFOUNDOPERATION - If the input element RbacOperation is not a valid RBAC Operation Name.
Name Type Description GroupNameOrId GroupNameOrId
optional
If specified, only the specified Group and its immediate children are returned. ListSubgroups xsd:boolean
optional
If TRUE, lists all the subgroups recursively. If GroupNameOrId is specified, then all its subgroups are listed recursively. If FALSE, only top level Groups are listed. If GroupNameOrId is specified, then the immediate children Groups of the Group are listed. Default Value is false. RbacOperation xsd:string
optional
Name of an RBAC Operation. If specified, only return Resource Groups for which the authenticated administrator has the required Capability and DFM.Database.Read. Default Value is DFM.Database.Read. This can be up To 255 characters long. The parameter is of the form: Application.Category.TypeOfAccess. For example: "DFM.Database.Read" or "DFM.Database.Write".
| Element definition: GroupListIterStartResult | [top] |
Name Type Description Records xsd:integer
Number which tells you how many items have been saved for future retrieval with GroupListIterNext.
Range: [1..2^31-1]Tag xsd:string
Tag To be used in subsequent calls To GroupListIterNext. It is an opaque handle used by the DFM station To identify a temporary store.
| Element definition: GroupMove | [top] |
Move the Group under a new parent Group. The Id of the Group does not change after the move.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EGROUPEXISTS - An attempt was made To create a new Group with the same Name as an already existing Group. Try again with a different Name.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINVALIDGROUPNAME - The proposed Group Name was not valid.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EPARENTGROUPDOESNOTEXIST - The parent Group Name or ID was not found.
- EPARENTGROUPNAMEAMBIGUOUS - The specified parent Group Name could refer To 2 or more Groups. Try again with a parent Group ID or a fully qualified parent Group Name.
- EACCESSDENIED - The user does not have the Capability To move the Group.
- EDATABASEERROR - A database Error occured.
Name Type Description GroupNameOrId GroupNameOrId
Name or ID of a Group. If a Group Name is specified, it must be fully qualified. NewGroupName xsd:string
optional
Group will be moved under the new parent Group with this Name. Groups may contain any printable ASCII character except slash characters. The Maximum Name Length is 64 characters. Group Name cannot be "global" or "all" or fully numeric. ParentGroupNameOrId GroupNameOrId
Name or ID of the new parent Group. If a Group Name is specified, it must be fully qualified.
| Element definition: GroupMoveResult | [top] |
[none]
| Element definition: GroupRename | [top] |
Change the Name of a Group.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EGROUPEXISTS - An attempt was made To create a new Group with the same Name as an already existing Group. Try again with a different Name.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EINVALIDGROUPNAME - The proposed Group Name was not valid.
- EACCESSDENIED - The user does not have the Capability To rename the Group.
- EDATABASEERROR - A database Error occured.
Name Type Description GroupNameOrId GroupNameOrId
Name or ID of a Group. If a Group Name is specified, it must be fully qualified. NewGroupName xsd:string
New Name of the Group. Groups may contain any printable ASCII character except slash characters. The Maximum Name Length is 64 characters. Group Name cannot be "all" or "global" or fully numeric.
| Element definition: GroupRenameResult | [top] |
[none]
| Element definition: GroupSetOptions | [top] |
Change one or more Options for a Group. Only Options that are specified will be updated. The remaining Options will retain their current Values. If there is any Error, then no Options are changed.
Error conditions:
- EGROUPDOESNOTEXIST - The Group Name or ID was not found.
- EOBJECTAMBIGUOUS - The specified Group Name could refer To 2 or more Groups. Try again with a Group ID or a fully qualified Group Name.
- EINTERNALERROR - An Error occurred while processing the Request. Try again later.
- EINVALIDINPUT - Invalid Value for one of the Options was specified.
- EACCESSDENIED - The user does not have the Capability To set Options for the Group.
- EDATABASEERROR - A database Error occured.
Name Type Description GroupNameOrId GroupNameOrId
Name or ID of a Group. If a Group Name is specified, it must be fully qualified. GroupOptionInfo GroupOptionInfo
New Option Values for this Group.
| Element definition: GroupSetOptionsResult | [top] |
[none]
| Element definition: ArrayOfGroupInfo | [top] |
Name Type Description GroupInfo GroupInfo[]
| Element definition: GroupNameOrId | [top] |
Name or ID of a Group. If a Group Name is specified, it must be fully qualified.
[none]
| Element definition: GroupOptionInfo | [top] |
Name Type Description ChargebackRate xsd:string
optional
The monthly chargeback cost, represented as a decimal floating-point number. Default: 0 GroupContact EmailAddressList
optional
Contact of the Resource Group. This is modifiable. Possible Value is e-mail of the owner. GroupOwner xsd:string
optional
Owner of the Resource Group. This is modifiable. SrmMaxLargeFiles xsd:integer
optional
Maximum number of large files To track during SRM walks on Paths in this Group. Default: 20
Range: [0..100000]SrmMaxNewMtimeFiles xsd:integer
optional
Maximum number of files with new mtimes To track during SRM walks on Paths in this Group. Default: 20
Range: [0..100000]SrmMaxOldAtimeFiles xsd:integer
optional
Maximum number of files with old atimes To track during SRM walks on Paths in this Group. Default: 20
Range: [0..100000]SrmMaxOldMtimeFiles xsd:integer
optional
Maximum number of files with old mtimes To track during SRM walks on Paths in this Group. Default: 20
Range: [0..100000]
| Element definition: ObjStatus | [top] |
A Status Value which can be associated with a DFM object. This typedef is an alias for the builtin ZAPI Type string. The Severity associated with an event has this Type. Possible Values are: 'unknown', 'normal', 'information', 'unmanaged' 'warning', 'Error', 'critical', 'emergency'.
In some contexts, it is important that severities are ordered (as above). For example, an alarm might be triggered if an event with a given Severity "or worse" occurs. In this example, worse means "after" in the list above.
- unknown: An object has an unknown Status when it transitions From one state To another. Ideally, an object will have this Status briefly. For example, when an object has been added, but not yet discovered.
- normal: An object has normal Status when it is working within the Thresholds specified in DFM.
- information: The information Events are normal occurrences on an object for which you can define alarms.
- unmanaged: An object is considered To be unmanaged when the login and Password are not set for the storage system or agent.
- warning: An object has the warning Status when an event related To the object occurred that an administrator should know about. The event will not cause Service disruption.
- Error: An object has Error Status when it does not cause any Service disruption, but it may affect performance.
- critical: An object has critical Status when it is still performing, but Service disruption may occur if corrective Action is not taken immediately.
- emergency: An object is in emergency Status when it stops performing unexpectedly and could lose data.
[none]
| Element definition: ObjectNameOrId | [top] |
Name or ID of an object.
[none]
| Element definition: EmailAddressList | [top] |
A list of email addresses. If more than one email Address is specified, the addresses must be seperated by a ','. Spaces (and other white space) are not allowed, either between addresses or in them. Unprintable characters are also invalid. The list may contain up To 255 characters.
[none]
| Element definition: GroupInfo | [top] |
Information about a single Group.
Name Type Description GroupPerfStatus ObjStatus
Status of the Group based on performance Events GroupStatus ObjStatus
Status of the Group based on all Events HasPrivilege xsd:boolean
Indicates if user has the Privilege checked by GroupListIterStart API. If TRUE, user has the requested Privilege on this Group. If FALSE, user does not have the requested Privilege, but Group is included because user has the requested Privilege on one or more subgroups of this Group. Group privileges are set using the RBAC APIs. Id xsd:integer
Numeric identifier of the Group.
Range: [0..2^31-1]Name xsd:string
Name of the Group. ParentGroupId xsd:integer
optional
Numeric identifier of the parent Group, if any. This element is not present for top level Groups.
Range: [0..2^31-1]ShortName xsd:string
Short Name of the Group. This is a short Name which does not include Name of the parent. SubgroupCount xsd:integer
Number of sub-groups under this parent Group.
Range: [0..2^31-1]Type xsd:string
The Type of the Members of the Group. Multiple Values are separated by commas. Possible Values: Empty, Hosts, Volumes, Qtrees, Configurations, Lun Paths, SRM Paths, Aggregates, Datasets, and Resource Pools.