AdminTask 对象的 IdMgrRealmConfig 命令组
可以使用 Jython 或 Jacl 脚本语言来配置联合存储库领域。IdMgrRealmConfig 组中的命令和参数可用于创建和管理领域配置。
- addIdMgrRealmBaseEntry
- createIdMgrRealm
- deleteIdMgrRealm
- deleteIdMgrRealmBaseEntry
- deleteIdMgrRealmDefaultParent
- getIdMgrDefaultRealm
- getIdMgrRepositoriesForRealm
- getIdMgrRealm
- listIdMgrRealms
- listIdMgrRealmBaseEntries
- listIdMgrRealmDefaultParents
- listIdMgrRealmURAttrMappings
- renameIdMgrRealm
- setIdMgrDefaultRealm
- setIdMgrRealmDefaultParent
- setIdMgrRealmURAttrMapping
- updateIdMgrRealm
addIdMgrRealmBaseEntry
addIdMgrRealmBaseEntry 命令向特定领域配置添加基本条目并将领域与存储库相链接。
目标对象
无。必需参数
- -name
- 指定领域的名称。(字符串,必需)
- -baseEntry
- 指定基本条目的名称。(字符串,可选)
可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask addIdMgrRealmBaseEntry {-name defaultWIMFileBasedRealm -baseEntry o=sampleFileRepository}
- 使用 Jython 字符串:
AdminTask.addIdMgrRealmBaseEntry ('[-name defaultWIMFileBasedRealm -baseEntry o=sampleFileRepository]')
- 使用 Jython 列表:
AdminTask.addIdMgrRealmBaseEntry (['-name', 'defaultWIMFileBasedRealm', '-baseEntry', 'o=sampleFileRepository'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask addIdMgrRealmBaseEntry {-interactive}
- 使用 Jython 字符串:
AdminTask.addIdMgrRealmBaseEntry ('[-interactive]')
- 使用 Jython 列表:
AdminTask.addIdMgrRealmBaseEntry (['-interactive'])
createIdMgrRealm
createIdMgrRealm 命令创建领域配置。
目标对象
无。必需参数
- -name
- 指定领域的名称。(字符串,必需)
可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
- -securityUse
- 指定一个字符串,它指示是现在、以后还是永不在安全性中使用此虚拟领域。缺省值为 active。其他值包括:inactive 和 nonSelectable。(字符串,可选)
- -delimiter
- 指定用于此领域的定界符。缺省值为 /。(字符串,可选)
- -allowOperationIfReposDown
- 指定系统是否允许存储库操作(例如 get 或 search)成功地完成,即使领域中的存储库处于关闭状态。缺省值为 false。(布尔值,可选)
避免故障: 即使指定了此参数,启动服务器时所有存储库也都必须可用,否则联合存储库无法正常工作。gotcha
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask createIdMgrRealm {-name realm1 -allowOperationIfReposDown true}
- 使用 Jython 字符串:
AdminTask.createIdMgrRealm ('[-name realm1 -allowOperationIfReposDown true]')
- 使用 Jython 列表:
AdminTask.createIdMgrRealm (['-name', 'realm1', '-allowOperationIfReposDown', 'true'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask createIdMgrRealm {-interactive}
- 使用 Jython 字符串:
AdminTask.createIdMgrRealm ('[-interactive]')
- 使用 Jython 列表:
AdminTask.createIdMgrRealm (['-interactive'])
deleteIdMgrRealm
deleteIdMgrRealm 命令删除您指定的领域配置。
目标对象
无。必需参数
- -name
- 域名称。(字符串,必需)
可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask deleteIdMgrRealm {-name realm1}
- 使用 Jython 字符串:
AdminTask.deleteIdMgrRealm ('[-name realm1]')
- 使用 Jython 列表:
AdminTask.deleteIdMgrRealm (['-name', 'realm1'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask deleteIdMgrRealm {-interactive}
- 使用 Jython 字符串:
AdminTask.deleteIdMgrRealm ('[-interactive]')
- 使用 Jython 列表:
AdminTask.deleteIdMgrRealm (['-interactive'])
deleteIdMgrRealmBaseEntry
deleteIdMgrRealmBaseEntry 命令从指定的领域配置中删除一个基本条目。
领域必须始终至少包含一个基本条目;因此,不能移除所有条目。
目标对象
无。必需参数
- -name
- 指定领域的名称。(字符串,必需)
- -baseEntry
- 指定基本条目的名称。(字符串,必需)
可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask deleteIdMgrRealmBaseEntry {-name realm1 -baseEntry entry1}
- 使用 Jython 字符串:
AdminTask.deleteIdMgrRealmBaseEntry ('[-name realm1 -baseEntry entry1]')
- 使用 Jython 列表:
AdminTask.deleteIdMgrRealmBaseEntry (['-name', 'realm1', '-baseEntry', 'entry1'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask deleteIdMgrRealmBaseEntry {-interactive}
- 使用 Jython 字符串:
AdminTask.deleteIdMgrRealmBaseEntry ('[-interactive]')
- 使用 Jython 列表:
AdminTask.deleteIdMgrRealmBaseEntry (['-interactive'])
deleteIdMgrRealmDefaultParent
使用 deleteIdMgrRealmDefaultParent 命令可以删除领域实体类型的缺省父代的映射。
目标对象
无。必需参数
- -entityTypeName
- 使用此参数来指定要删除缺省父代映射的有效受支持实体类型的名称。您可以指定星号 (*) 以删除领域中所有实体类型的缺省父代映射。(字符串,必需)
可选参数
- -name
- 使用此参数来指定要删除映射的有效领域名称。如果未指定 -name 参数,那么此命令将删除 defaultWIMFileBasedRealm(联合存储库配置中的缺省领域)的映射。(字符串,可选)
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask deleteIdMgrRealmDefaultParent {-entityTypeName entity_type}
- 使用 Jython 字符串:
AdminTask.deleteIdMgrRealmDefaultParent ('[-entityTypeName entity_type]')
- 使用 Jython 列表:
AdminTask.deleteIdMgrRealmDefaultParent (['-entityTypeName', 'entity_type'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask deleteIdMgrRealmDefaultParent {-interactive}
- 使用 Jython 字符串:
AdminTask.deleteIdMgrRealmDefaultParent ('[-interactive]')
- 使用 Jython 列表:
AdminTask.deleteIdMgrRealmDefaultParent (['-interactive'])
getIdMgrDefaultRealm
getIdMgrDefaultRealm 命令返回缺省领域名。
目标对象
无。必需参数
无。可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask getIdMgrDefaultRealm
- 使用 Jython 字符串:
AdminTask.getIdMgrDefaultRealm()
- 使用 Jython 列表:
AdminTask.getIdMgrDefaultRealm()
交互方式示例用法:
- 使用 Jacl:
$AdminTask getIdMgrDefaultRealm {-interactive}
- 使用 Jython 字符串:
AdminTask.getIdMgrDefaultRealm ('[-interactive]')
- 使用 Jython 列表:
AdminTask.getIdMgrDefaultRealm (['-interactive'])
getIdMgrRepositoriesForRealm
getIdMgrRepositoriesForRealm 命令为对指定的领域配置的存储库返回特定于存储库的详细信息。
目标对象
无。必需参数
- -name
- 指定领域的名称。(字符串,必需)
可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask getIdMgrRepositoriesForRealm {-name realm1}
- 使用 Jython 字符串:
AdminTask.getIdMgrRepositoriesForRealm ('[-name realm1]')
- 使用 Jython 列表:
AdminTask.getIdMgrRepositoriesForRealm (['-name', 'realm1'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask getIdMgrRepositoriesForRealm {-interactive}
- 使用 Jython 字符串:
AdminTask.getIdMgrRepositoriesForRealm ('[-interactive]')
- 使用 Jython 列表:
AdminTask.getIdMgrRepositoriesForRealm (['-interactive'])
getIdMgrRealm
getIdMgrRealm 命令返回您指定的领域的配置参数。
目标对象
无。必需参数
- -name
- 指定领域的名称。(字符串,必需)
可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask getIdMgrRealm {-name realm1}
- 使用 Jython 字符串:
AdminTask.getIdMgrRealm ('[-name realm1]')
- 使用 Jython 列表:
AdminTask.getIdMgrRealm (['-name', 'realm1'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask getIdMgrRealm {-interactive}
- 使用 Jython 字符串:
AdminTask.getIdMgrRealm ('[-interactive]')
- 使用 Jython 列表:
AdminTask.getIdMgrRealm (['-interactive'])
listIdMgrRealms
listIdMgrRealms 命令返回已配置的领域的所有名称。
目标对象
无。必需参数
无。可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask listIdMgrRealms
- 使用 Jython 字符串:
AdminTask.listIdMgrRealms()
- 使用 Jython 列表:
AdminTask.listIdMgrRealms()
交互方式示例用法:
- 使用 Jacl:
$AdminTask listIdMgrRealms {-interactive}
- 使用 Jython 字符串:
AdminTask.listIdMgrRealms ('[-interactive]')
- 使用 Jython 列表:
AdminTask.listIdMgrRealms (['-interactive'])
listIdMgrRealmBaseEntries
listIdMgrRealmBaseEntries 命令返回已配置的领域的所有名称。
目标对象
无。必需参数
- -name
- 指定领域的名称。(字符串,必需)
可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask listIdMgrRealmBaseEntries {-name realm1}
- 使用 Jython 字符串:
AdminTask.listIdMgrRealmBaseEntries ('[-name realm1]')
- 使用 Jython 列表:
AdminTask.listIdMgrRealmBaseEntries (['-name', 'realm1'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask listIdMgrRealmBaseEntries {-interactive}
- 使用 Jython 字符串:
AdminTask.listIdMgrRealmBaseEntries ('[-interactive]')
- 使用 Jython 列表:
AdminTask.listIdMgrRealmBaseEntries (['-interactive'])
listIdMgrRealmDefaultParents
使用 listIdMgrRealmDefaultParents 命令可以列示指定领域中所有实体类型的缺省父代 uniqueName 的映射。
目标对象
无。必需参数
无。可选参数
- -name
- 使用此参数来指定要列示映射的有效领域名称。如果未指定 -name 参数,那么此命令将返回 defaultWIMFileBasedRealm(联合存储库配置中的缺省领域)的映射。(字符串,可选)
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
返回值
listIdMgrRealmDefaultParents 命令返回从每种实体类型到指定领域的缺省父代 uniqueName 的映射。结果将作为一个 Map 返回,其中,键是 entityType,值是 parentUniqueName。示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask listIdMgrRealmDefaultParents {-name realm_name}
- 使用 Jython 字符串:
AdminTask.listIdMgrRealmDefaultParents ('[-name realm_name]')
- 使用 Jython 列表:
AdminTask.listIdMgrRealmDefaultParents ((['-name', 'realm_name'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask listIdMgrRealmDefaultParents {-interactive}
- 使用 Jython 字符串:
AdminTask.listIdMgrRealmDefaultParents ('[-interactive]')
- 使用 Jython 列表:
AdminTask.listIdMgrRealmDefaultParents (['-interactive'])
listIdMgrRealmURAttrMappings
使用 listIdMgrRealmURAttrMappings 命令可以列示用户注册表的用户或组属性与指定领域的联合存储库属性之间的映射。
目标对象
无。
可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
- -name
- 使用此参数来指定要列示映射的有效领域名称。
如果未指定 -name 参数,那么 listIdMgrRealmURAttrMappings 命令将返回联合存储库配置中缺省领域的映射。
(字符串,可选)
返回值
- 键是用户注册表属性名称(URAttrName 参数)。
- 值是另一个 HashMap,该 HashMap 包含 propertyForInput 和 propertyForOutput 作为键,并包含相应映射作为值。
{userDisplayName={propertyForInput=principalName, propertyForOutput=principalName},
userSecurityName={propertyForInput=principalName, propertyForOutput=principalName},
uniqueUserId={propertyForInput=uniqueName, propertyForOutput=uniqueName},
uniqueGroupId={propertyForInput=uniqueName, propertyForOutput=uniqueName},
groupSecurityName={propertyForInput=cn, propertyForOutput=cn},
groupDisplayName={propertyForInput=cn, propertyForOutput=cn}}
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask listIdMgrRealmURAttrMappings
- 使用 Jython 字符串:
AdminTask.listIdMgrRealmURAttrMappings()
- 使用 Jython 列表:
AdminTask.listIdMgrRealmURAttrMappings()
交互方式示例用法:
- 使用 Jacl:
$AdminTask listIdMgrRealmURAttrMappings {-interactive}
- 使用 Jython 字符串:
AdminTask.listIdMgrRealmURAttrMappings ('[-interactive]')
- 使用 Jython 列表:
AdminTask.listIdMgrRealmURAttrMappings (['-interactive'])
renameIdMgrRealm
renameIdMgrRealm 命令重命名您指定的领域的名称。
目标对象
无。必需参数
- -name
- 指定领域的名称。(字符串,必需)
- -newName
- 指定领域的新名称。(字符串,必需)
可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask renameIdMgrRealm {-name realm1 -newName realm2}
- 使用 Jython 字符串:
AdminTask.renameIdMgrRealm ('[-name realm1 -newName realm2]')
- 使用 Jython 列表:
AdminTask.renameIdMgrRealm (['-name', 'realm1', '-newName', 'realm2'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask renameIdMgrRealm {-interactive}
- 使用 Jython 字符串:
AdminTask.renameIdMgrRealm ('[-interactive]')
- 使用 Jython 列表:
AdminTask.renameIdMgrRealm (['-interactive'])
setIdMgrDefaultRealm
setIdMgrDefaultRealm 命令用于设置缺省领域名。
必需参数
- -name
- 指定当调用者未在上下文中指定任何内容时用作缺省领域的领域名称。(字符串,必需)
可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask setIdMgrDefaultRealm {-name realm1}
- 使用 Jython 字符串:
AdminTask.setIdMgrDefaultRealm ('[-name realm1]')
- 使用 Jython 列表:
AdminTask.setIdMgrDefaultRealm (['-name', 'realm1'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask setIdMgrDefaultRealm {-interactive}
- 使用 Jython 字符串:
AdminTask.setIdMgrDefaultRealm ('[-interactive]')
setIdMgrRealmDefaultParent
使用 setIdMgrRealmDefaultParent 命令可以设置或修改指定领域中实体类型的缺省父代 uniqueName。
目标对象
无。
必需参数
- -entityTypeName
- 使用此参数来指定要设置或修改缺省父代的有效受支持实体类型的名称。(字符串,必需)
- -parentUniqueName
- 使用此参数来指定指定领域中实体类型的缺省父代。指定的缺省父代应该是此领域中的有效 uniqueName。(字符串,必需)
可选参数
- -name
- 使用此参数来指定要设置或修改映射的有效领域名称。如果未指定 -name 参数,那么此命令将设置或修改 defaultWIMFileBasedRealm(联合存储库配置中的缺省领域)的映射。(字符串,可选)
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask setIdMgrRealmDefaultParent {-entityTypeName entity_type -parentUniqueName unique_name}
- 使用 Jython 字符串:
AdminTask.setIdMgrRealmDefaultParent ('[-entityTypeName entity_type -parentUniqueName unique_name]')
- 使用 Jython 列表:
AdminTask.setIdMgrRealmDefaultParent (['-entityTypeName', 'entity_type', '-parentUniqueName', 'unique_name'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask setIdMgrRealmDefaultParent {-interactive}
- 使用 Jython 字符串:
AdminTask.setIdMgrRealmDefaultParent ('[-interactive]')
- 使用 Jython 列表:
AdminTask.setIdMgrRealmDefaultParent (['-interactive'])
setIdMgrRealmURAttrMapping
使用 setIdMgrRealmURAttrMapping 命令来设置或修改从用户注册表的用户或组属性到指定领域的联合存储库属性的映射。
在连接方式和本地方式下,setIdMgrRealmURAttrMapping 命令都可用。如果以连接方式运行 setIdMgrRealmURAttrMapping 命令,那么领域属性映射更改将在服务器重新启动后生效。
目标对象
无。
必需参数
- -URAttrName
- 使用此参数来指定用户注册表中要映射的用户或组属性的名称。下列区分大小写的值对 URAttrName 参数有效:
- uniqueUserId
- userSecurityName
- userDisplayName
- uniqueGroupId
- groupSecurityName
- groupDisplayName
避免故障: 如果对同一用户注册表属性名称多次运行 setIdMgrRealmURAttrMapping 命令,那么将覆盖先前的值。gotcha
(字符串,必需)
- -propertyForInput
- 使用此参数指定当指定的用户注册表属性(URAttrName 参数)是用户注册表接口的输入参数时映射到该属性的联合存储库属性的名称。(字符串,必需)
- -propertyForOutput
- 使用此参数指定当指定的用户注册表属性(URAttrName 参数)是用户注册表接口的输出参数(返回值)时映射到该属性的联合存储库属性的名称。(字符串,必需)
可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
- -name
- 使用此参数来指定要设置或修改映射的有效领域名称。如果未指定 name 参数,那么 setIdMgrRealmURAttrMapping 命令将使用联合存储库配置中的缺省领域。(字符串,可选)
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask setIdMgrRealmURAttrMapping {-URAttrName uniqueUserId -propertyForInput uniqueName -propertyForOutput uniqueName}
- 使用 Jython 字符串:
AdminTask.setIdMgrRealmURAttrMapping ('[-URAttrName uniqueUserId -propertyForInput uniqueName -propertyForOutput uniqueName]')
- 使用 Jython 列表:
AdminTask.setIdMgrRealmURAttrMapping (['-URAttrName', 'uniqueUserId', '-propertyForInput', 'uniqueName', '-propertyForOutput', 'uniqueName'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask setIdMgrRealmURAttrMapping {-interactive}
- 使用 Jython 字符串:
AdminTask.setIdMgrRealmURAttrMapping ('[-interactive]')
- 使用 Jython 列表:
AdminTask.setIdMgrRealmURAttrMapping (['-interactive'])
updateIdMgrRealm
updateIdMgrRealm 命令更新您指定的领域的配置。
目标对象
无。必需参数
- -name
- 指定领域的名称。(字符串,必需)
可选参数
- -securityDomainName
- 使用此参数来指定用于唯一标识安全域的名称。如果未指定此参数,那么此命令将使用全局联合存储库。(字符串,可选)
- -securityUse
- 指定一个字符串,它指示是现在、以后还是永不在安全性中使用此领域。缺省值为 active。其他值包括:inactive 和 nonSelectable。(字符串,可选)
- -delimiter
- 指定用于此领域的定界符。缺省值为 /。(字符串,可选)
- -allowOperationIfReposDown
- 指定系统是否允许存储库操作(例如 get 或 search)成功地完成,即使领域中的存储库处于关闭状态。(布尔值,可选)
避免故障: 即使指定了此参数,启动服务器时所有存储库也都必须可用,否则虚拟成员管理器无法正常工作。gotcha
示例
批处理方式示例用法:
- 使用 Jacl:
$AdminTask updateIdMgrRealm {-name realm1}
- 使用 Jython 字符串:
AdminTask.updateIdMgrRealm ('[-name realm1]')
- 使用 Jython 列表:
AdminTask.updateIdMgrRealm (['-name', 'realm1'])
交互方式示例用法:
- 使用 Jacl:
$AdminTask updateIdMgrRealm {-interactive}
- 使用 Jython 字符串:
AdminTask.updateIdMgrRealm ('[-interactive]')
- 使用 Jython 列表:
AdminTask.updateIdMgrRealm (['-interactive'])