3.2. O que é a ajuda do IPA
A ajuda do IPA é um sistema de documentação embutido para o servidor IdM.
A interface de linha de comando IPA (CLI) gera tópicos de ajuda disponíveis a partir de módulos plug-in IdM carregados. Se você quiser executar a ajuda IPA com sucesso, você precisa fazê-lo:
- Ter um servidor IdM instalado e funcionando.
- Ser autenticado com um bilhete Kerberos válido.
A execução do comando ipa help
sem opções exibe informações sobre o uso básico da ajuda e os exemplos de comando mais comuns.
A execução de ajuda com opções tem a seguinte sintaxe:
$ ipa help [TOPIC | COMMAND | topics | commands]
-
[]
- Brackets significa que todos os parâmetros são opcionais e você pode escrever apenasipa help
e o comando será executado. -
|
-_ The caractere do tubo significa or. Portanto, você pode usar TOPIC ou COMMAND ou tópicos ou comandos com o comando básicoipa help
. -
topics
- You pode executar o comandoipa help topics
e ele será executado corretamente. O comando exibe uma lista de tópicos que são cobertos pela ajuda do IPA, por exemplo,user
,cert
,server
e muitos outros. -
TOPIC
- The TOPIC com letras maiúsculas significa variável, portanto, você pode usar o tópico específico, por exemplo,ipa help user
-
commands
- You pode executar o comandoipa help commands
e ele será executado corretamente. O comando exibe uma lista de comandos que são cobertos pela ajuda do IPA, por exemplo,user-add
,ca-enable
,server-show
e muitos outros. -
COMMAND
- The COMMAND com letras maiúsculas significa variável, portanto, você pode usar o comando particular, por exemplo,ipa help user-add