O Directory Utility é um aplicativo Java que pode ser usado para gerenciar informações de configuração de usuário, grupo ou sessão armazenadas no Host On-Demand ou em um servidor LDAP. O Directory Utility permite incluir ou atualizar um grande número de usuários, grupos ou sessões a partir de um arquivo ASCII, em vez de individualmente por meio do cliente de Administração. Por exemplo, é possível usar o utilitário para:
O Utilitário de Diretório utiliza um arquivo ASCII que define todos os grupos, usuários e sessões. O arquivo de texto precisa estar no formato XML, com uma extensão .xml.
O Directory Utility pode ser executado usando uma interface gráfica com o usuário ou uma interface da linha de comandos.
Para iniciar a interface gráfica com o usuário...
Na interface gráfica com o usuário do Directory Utility, insira os campos a seguir, conforme apropriado:
Essa opção é ignorada para as ações add, delete e update no arquivo XML de entrada.
Em sistemas Windows, o arquivo de comando ou script para executar o Directory Utility e o arquivo de amostra está localizado no diretório C:\Program Files\IBM\HostOnDemand\lib\samples\DirUtil. O arquivo de comandos é chamado DirUtil.cmd e o arquivo de texto de amostra é chamado sample.xml. O comando ou o arquivo de script para outros sistemas operacionais e o arquivo de texto de amostra estão localizados no diretório hostondemand\lib\samples\DirUtilCommandFiles. O arquivo de texto de amostra é chamado Sample.xml. O comando ou arquivos de scipt são chamados:
Para executar o Utilitário de Diretório, digite o seguinte na linha de comandos:
 A ordem dos parâmetros é importante. |
| DirUtil-xxx filename.xml admin password [hostname] [port] [CO |
| O Gerenciador de Serviços do Host On-Demand deve ser executado no servidor Host On-Demand especificado pelo nome do host a fim de que o Utilitário do Diretório atualize as informações de configuração do Host On-Demand ou do LDAP. |
Por exemplo, em AIX você executaria:
DirUtil-AIX file.xml admin password myhostname 8999 CON
A GUI do Directory Utility é a interface da GUI para o aplicativo da linha de comandos. É possível usá-la para gerenciar usuários, grupos ou as informações de configurações de sessão que são armazenadas no Host On-Demand ou em um servidor LDAP. A GUI do Directory Utility permite incluir ou atualizar um grande número de usuários, grupos ou sessões a partir de um arquivo ASCII, em vez de individualmente por meio do cliente de Administração.
Há um sample.xml que já fornecido na pasta DirUtil. O arquivo de texto precisa estar no formato XML, com uma extensão .xml para a GUI para reconhecer as opções.
No S.O. Windows de 64 bits, o utilitário pode ser ativado com o DirUtilGUI.bat que está localizado no diretório C:\Program Files\IBM\HostOnDemand\lib\samples\DirUtil.
No S.O. Windows de 32 bits, o utilitário pode ser ativado com o DirUtilGUI.bat que está localizado no diretório C:\Program Files (x86)\IBM\HostOnDemand\lib\samples\DirUtil.
Em um S.O. baseado no Unix/Linux, o utilitário pode ser ativado com o DirUtilGUI.sh que está localizado no diretório /opt/IBM/HostOnDemand/lib/samples/DirUtil.
Nota: Estes são os diretórios padrão nos quais o HOD é instalado. No caso de o HOD ser instalado em um diretório definido pelo usuário, o local seria o diretório <<HOD_INSTALL_DIRECTORY>>\lib\samples\DirUtil. O comando ou arquivos de scipt são chamados:
A GUI tem os campos Nome do usuário e Senha, em que o nome do usuário e a senha de um administrador são necessários. Por padrão, admin é configurado como o nome do usuário e password é configurado como a senha.
O nome do host é predefinido como localhost e o número da porta é predefinido como 8999. Também é possível inserir o nome do host e o número da porta desejdos no caso de mudanças.
É necessário escolher o Arquivo XML que contém detalhes sobre o usuário, grupo ou sessão. Suas opções incluem Atualizar, Incluir e Excluir.
A caixa de seleção Gerar arquivo HTML para a ação Listar é usada para gerar uma lista de usuários ou grupos conforme a opção definida no arquivo xml. O campo Arquivo HTML é gerado automaticamente quando o arquivo XML é selecionado. O arquivo html gerado automaticamente seria nomeado com o nome do arquivo xml e colocado no mesmo local do arquivo xml.
A geração da lista de Usuário(s) ou Grupo(s) no arquivo html é válida somente quando a caixa de seleção Gerar arquivo HTML para a ação Listar é marcada e uma lista de Usuário(s) ou Grupo(s) seria listada no arquivo HTML padrão se inalterado.
É possível limpar a saída de console clicando no botão Limpar. Também é possível copiá-la para a área de transferência com o clique do botão Copiar.
É possível clicar em Ajuda para abrir o conteúdo de ajuda de DirUtilGUI.
Aqui estão dois exemplos de como gerar a ação listar no arquivo HTML:
<action type = "list">
<userlist>
<userid>*</userid>
</userlist>
</action>
<action type = "list">
<grouplist>
<groupid>*</groupid>
</grouplist>
</action>
As descrições dos elementos abaixo descrevem o formato dos elementos XML válidos que podem ser incluídos no arquivo XML utilizado pelo Utilitário de Diretório. Presume-se uma compreensão básica do XML. As linhas que começam com um "<!--" e terminam com "-->" são tratadas como comentários. Os elementos são sensíveis a maiúsculas e minúsculas.
Para criar ou editar o arquivo XML, você deve utilizar um editor ASCII que gere caracteres unicode válidos. Se receber o erro DIR0037 Erro fatal: Caractere XML Inválido durante a utilização do arquivo XML com o Utilitário de Diretório, isso significa que o editor ASCII não gerou caracteres unicode válidos. Utilize um editor ASCII diferente que gere caracteres unicode válidos.
<dirscript><action><group><groupid><description><parent><removeusers><user><userid><groupid><description><authentication><pw><nativeid><savepref><session><filename><groupid><userid><description><userlist><userid><groupid><filename><grouplist><userid><groupid><filename>
O elemento raiz no arquivo XML que contém todos os outros elementos e identifica o documento como aquele que pode ser processado pelo Utilitário do Diretório.
Atributos: nenhum
Elementos exigidos: <tipo de ação=xxx>
Elementos opcionais: nenhum
A ação que é executada nos elementos incluídos no elemento <action>. É possível ter vários elementos action dentro do elemento <dirscript>. Os elementos colocados fora do elemento <dirscript> ou desse elemento no arquivo XML serão ignorados pelo Utilitário de Diretório.
Valores: adicionar, excluir, atualizar ou listar
Elementos requeridos: Pelo menos um dos seguintes elementos é requerido no elemento <action>:
 |
O Utilitário de Diretório não suporta o elemento <grouplist> para LDAP. |
O elemento de inclusão para um grupo.
Atributos: nenhum
Elementos exigidos:
groupid será convertido em letras maiúsculas quando o grupo for incluído. Se estiver
utilizando o LDAP, o groupid poderá ser composto de letras maiúsculas e minúsculas.Elementos opcionais:
O elemento de inclusão para um usuário.
Atributos: nenhum
Elementos exigidos:
userid será convertido em letras minúsculas. Se estiver utilizando o LDAP o userid
pode ser composto de letras maiúsculas e minúsculas.Elementos opcionais:
A autenticação utilizada para o usuário. É possível utilizar autenticação nativa, somente se estiver utilizando também LDAP ou autenticação de senha. Não será configurada nenhuma autenticação para o usuário se esse elemento não for especificado, quando o tipo de ação for adicionar, ou se native estiver selecionado e o LDAP não estiver sendo utilizado.
Atributos: pw ou native
Elementos exigidos:
Elementos opcionais:
O elemento de inclusão para uma sessão.
Atributos: nenhum
Elementos exigidos:
Pelo menos um dos dois seguintes tipos de elementos é exigido no elemento <session>:
| É possível especificar vários usuários ou grupos no elemento de sessão, mas
não é possível especificar usuários e grupos no mesmo elemento de sessão. |
Elementos opcionais: nenhum
O elemento de inclusão para uma pesquisa baseada no usuário.
Atributos: nenhum
Elementos requeridos: Não mais que um de cada um dos elementos a seguir pode ser utilizado:
| Se a marcação <userid> ou <groupid> estiver
ausente, o Utilitário de Diretório assumirá um caractere curinga para o elemento e executará a pesquisa de acordo. |
Elementos opcionais: Utilize este elemento apenas uma vez para referir-se a apenas um arquivo:
| O Utilitário de Diretório grava em um arquivo padrão
se não for especificado um nome do arquivo. O arquivo padrão é
DirUtilList.xml, que reside no diretório
hostondemand\lib\samples\DirUtil. Sempre que não for especificado um
arquivo de saída, a função listar adicionará os resultados de sua
pesquisa a DirUtilList.xml. Consulte Utilizando a Saída da Função
Listar. |
O elemento de inclusão para uma pesquisa baseada em grupo.
|
O Utilitário de Diretório não suporta este elemento para LDAP. |
Atributos: nenhum
Elementos requeridos: Não mais que um de cada um dos elementos a seguir pode ser utilizado:
| Se a marcação <userid> ou <groupid> estiver
ausente, o Utilitário de Diretório assumirá um caractere curinga para o elemento e executará a pesquisa de acordo. |
Elementos opcionais: Utilize este elemento apenas uma vez para referir-se a apenas um arquivo:
| O Utilitário de Diretório grava em um arquivo padrão
se não for especificado um nome do arquivo. O arquivo padrão é
DirUtilList.xml, que reside no diretório
hostondemand\lib\samples\DirUtil. Sempre que não for especificado um
arquivo de saída, a função listar adicionará os resultados de sua
pesquisa a DirUtilList.xml. Consulte Utilizando a Saída da Função
Listar. |
Abaixo está um arquivo XML de exemplo que demonstra as ações adicionar e listar. Ele adiciona três grupos, adiciona os usuários aos grupos e, se as sessões forem exportadas e os comentários removidos, adiciona as sessões aos usuários e grupos. (Para excluir ou atualizar usuários, grupos ou sessões, altere o tipo de ação para excluir ou atualizar e altere os elementos de acordo.) No Windows NT e Windows 2000, este arquivo de amostra, chamado sample.xml, está localizado no diretório C:\Program Files\IBM\HostOnDemand\lib\samples\DirUtil. O arquivo de texto sample.xml para os outros sistemas operacionais está localizado no diretório hostondemand\lib\samples\DirUtilCommandFiles.
| Este exemplo usa a ação listar
em seu formato mais simples: ela envia uma lista de todos os usuários e grupos para
o arquivo de saída XML padrão do Directory Utility. Para obter informações sobre pesquisas
mais sofisticadas e como utilizar sua saída, consulte Pesquisando com a Função Listar. |
<?xml version="1.0" encoding="UTF-8"?>
<!-- Iniciar DTD - O DTD não deve ser modificado.-->
<!DOCTYPE dirscript [
<!ELEMENT dirscript (action)+>
<!ELEMENT action (group | user | session)+>
<!ELEMENT group (groupid, description?, parent?, removeusers?)>
<!ELEMENT user (userid, groupid*, description?, authentication?, savepref?, removegroupid?)>
<!ELEMENT session (filename?, (groupid | userid)+, description?)>
<!ELEMENT groupid (#PCDATA)>
<!ELEMENT userid (#PCDATA)>
<!ELEMENT description (#PCDATA)>
<!ELEMENT userlist (userid+, groupid+, filename+)>
<!ELEMENT grouplist (userid+, groupid+, filename+)>
<!ELEMENT parent (#PCDATA)>
<!ELEMENT removeusers (#PCDATA)>
<!ELEMENT removegroupid (#PCDATA)>
<!ELEMENT authentication ((pw?, changepw?) | (nativeid))>
<!ELEMENT pw (#PCDATA)>
<!ELEMENT changepw (#PCDATA)>
<!ELEMENT nativeid (#PCDATA)>
<!ELEMENT savepref (#PCDATA)>
<!ELEMENT filename (#PCDATA)>
<!ATTLIST action type (add | delete | update | list) #REQUIRED>
<!ATTLIST authentication type (pw | native) #REQUIRED>
]>
<!-- End DTD -->
<dirscript> <action type="add"> <!-- Add
three groups --> <group>
<groupid>3270GROUP</groupid>
<description>Group with 3270 sessions</description>
</group> <group>
<groupid>5250GROUP</groupid>
<description>Group with 5250 sessions</description>
</group> <group>
<groupid>mygroup</groupid> <description>Group
with parent</description> <!-- the parent element should
only be specified if using LDAP --> <!--
<parent>3270GROUP</parent> --> </group>
<!-- Incluir um usuário ao grupo 3270 e fornecer-lhe uma senha. -->
<user>
<userid>user1</userid>
<description>First User</description>
<authentication type="pw">
<pw>mypw</pw>
<changepw>yes</changepw>
</authentication>
<groupid>3270GROUP</groupid>
</user>
<!-- Adicionar um usuário ao grupo 5250 e não permitir que salve suas preferências de sessão -->
<user>
<userid>user2</userid>
<description>Second User</description>
<authentication type="pw">
<pw>mypw</pw>
<changepw>yes</changepw>
</authentication>
<groupid>3270GROUP</groupid>
<savepref>no</savepref>
</user>
<!-- Os elementos de sessão estão comentados porque o arquivo pode não existir. -->
<!-- Se desejar incluir uma sessão, exporte uma sessão com o -->
<!-- nome do arquvo correto e remova as tags de comentário antes de executar DirUtil. -->
<!-- Incluir uma sessão ao grupo 3270 -->
<!--
<session>
<description>3270 Display</description>
<filename>3270dsp.hod</filename>
<groupid>3270GROUP</groupid>
</session>
-->
<!-- Incluir uma sessão ao grupo 5250 -->
<!--
<session>
<description>5250 Display</description>
<filename>5250dsp.hod</filename>
<groupid>5250GROUP</groupid>
</session>
-->
<!-- Incluir uma sessão ao user1 -->
<!--
<session>
<description>3270 Printer</description>
<filename>3270prt.hod</filename>
<userid>user1</userid>
</session>
-->
</action>
<!-- Listar todos os usuários e grupos no sistema e enviar a saída para o arquivo de saída XML padrão -->
<!--
<action type = "list">
<userlist>
<userid>*</userid>
</userlist>
<grouplist>
<userid>*</userid>
<groupid>*</groupid>
</grouplist>
</action>
-->
</dirscript>
| Informações Básicas de Pesquisa | |
| Utilizando Caracteres Curinga | |
| Exemplos de Pesquisas |
Informações Básicas de Pesquisa
Chame a função listar designando-a como um valor para um tipo de
ação: <action type="list">. Em seguida, você especifica
qualquer um, ou os dois tipos de pesquisa (que se aplicam apenas a usuários
e grupos existentes):
|
A pesquisa baseada em grupo não é suportada para o LDAP. |
Para cada tipo de pesquisa, você pode definir critérios apenas com os elementos <userid> e <groupid>. No entanto, você tem a flexibilidade para incorporar caracteres curinga em seus critérios de pesquisa. Como é possível utilizar qualquer número de caracteres curinga e colocá-los em qualquer localização na cadeia de pesquisa, você pode fazer uma pesquisa tão aberta quanto desejar.
Critérios padrão: Quando você não especifica um dos elementos <userid> ou <groupid> (ou não especifica ambos), a função de lista é padronizada com a hipótese de um caractere curinga para o elemento(s). Portanto, você tem a garantia da pesquisa mais aberta possível.
O Utilitário de Diretório grava a saída da pesquisa em um arquivo XML.
Utilizando Caracteres Curinga
O caractere curinga
é o asterisco (*).
O Utilitário de Diretório suporta virtualmente qualquer posicionamento de caractere curinga para as duas marcações pesquisáveis, <groupid> e <userid>. Os caracteres curinga podem aparecer em qualquer elemento pesquisável, em ambos os elementos ou em nenhum. Eles podem aparecer qualquer número de vezes, intercalados com caracteres alfanuméricos ou com eles mesmos. Se você omitir qualquer uma das duas marcações de ID dos critérios de pesquisa, o Utilitário de Diretório assumirá o elemento como um caractere curinga (*) e executará a pesquisa de caracteres curinga para essa marcação, por padrão.
Exemplos de posicionamento de caracteres curinga válidos:
| <userid>*</userid> | Todos os Usuários |
| <groupid>*</groupid> | Todos os Grupos |
| <userid>a*</userid> <groupid>*</groupid> |
Usuários com ID que começa com um "a" e em qualquer grupo |
| <userid>a*s</userid> <groupid>hod</groupid> |
Usuários com ID que começa com um "a" e termina com um "s," no grupo hod |
| <userid>alhines</userid> <groupid>hod</groupid> |
Usuário "alhines" no grupo hod |
Exemplos de Pesquisas
Exemplos que combinam todos os elementos na função listar:
| As informações gerais de resumo para a função listar, tais como contagem de pesquisas executadas, seguem a mesma estrutura que outras informações de resumo do Utilitário de Diretório. Você pode enviar os dados de resumo da lista para o console, arquivo de log ou ambos. |
Como toda a saída da função listar é gravada em um arquivo XML, você pode reutilizá-la imediatamente como entrada para outras funções do Utilitário de Diretório. No arquivo de saída XML, você apenas altera o comando de ação de listar para adicionar, excluir ou modificar.
Se você nomear um arquivo de saída (com a marcação <filename>) quando inserir critérios de pesquisa, o Utilitário de Diretório gravará os resultados da lista no diretório e arquivo designados. Consulte exemplos de pesquisa. Se não for fornecido um nome de arquivo de saída, o Utilitário de Diretório armazenará os resultados no arquivo padrão, DirUtilList.xml, que reside no diretório hostondemand\lib\samples\DirUtil. Sempre que não for especificado um arquivo para saída de pesquisa, a função listar anexará os resultados a DirUtilList.xml.
Se você especificar erroneamente um caminho de arquivo inexistente, os resultados serão os mesmos: o Utilitário de Diretório gravará no arquivo padrão, adicionando a seu conteúdo com cada nova pesquisa.
| Para ambientes Unix: Assegure-se de que os nomes de caminhos dos arquivos de saída XML sejam válidos de acordo com o sistema operacional Unix específico. Por exemplo, se seu sistema operacional não identificar todos os caracteres do nome de caminho do arquivo, a interpretação dos caracteres desconhecidos poderá resultar no nome de arquivo inválido. Com isso, você não poderá abrir o arquivo de saída e recuperar os resultados da pesquisa. |
<dirscript>
<action type="list">
<userlist>
<userid>*</userid>
<groupid>*</groupid>
</userlist>
<grouplist>
<userid>*</userid>
<groupid>*</groupid>
</grouplist>
<action>
<dirscript>
Você gera a seguinte saída no arquivo XML padrão, DirUtilList.xml:
<!--Searching based on: Userlist -->
<!--with: userid= * -->
<!-- groupid= * -->
<dirscript>
<action type="list">
<user>
<userid>user1</userid>
<groupid>hod</groupid>
<description></description>
<authentication>pw</authentication>
</user>
<user>
<userid>user2</userid>
<groupid>group2</groupid>
<description></description>
<authentication>nativeid</authentication>
</user>
</action>
</dirscript>
<!--Searching based on: Grouplist -->
<!--with: userid= * -->
<!-- groupid= * -->
<dirscript>
<action type="list">
<group>
<groupid>hod1</groupid>
<description>Hod Users</description>
<parent></parent>
</group>
<group>
<groupid>group2</groupid>
<description>Other Users</description>
<parent></parent>
</group>
</action>
</dirscript>