Uzyskiwanie pomocy na temat programów narzędziowych wiersza komend

Podczas wykonywania funkcji administracyjnych przy użyciu interfejs wiersza komendmożna uzyskać dodatkowe informacje pomocnicze dla wszystkich zasobów.

Zanim rozpoczniesz

Pobierz program interfejs wiersza komend z konsola i zainstaluj go na komputerze lokalnym. Więcej informacji na ten temat zawiera publikacja Czynności pokrewne.

Informacje o tej czynności

Pomoc dla wszystkich zasobów systemowych, atrybutów i metod można uzyskać na interfejs wiersza komend. To zadanie udostępnia podstawowe informacje na temat opcji wywoływania funkcji pomocy produktu interfejs wiersza komend .

Użyj komendy help , aby uzyskać pomoc dotyczącą składni komend, dostępnych komend i trybu interaktywnego. Uruchom interfejs wiersza komend w trybie interaktywnym, inicjując przy użyciu wymaganych parametrów -u -p i -h , ale nie uwzględniaj parametrów -c ani -f . Następnie wpisz help, jak pokazano w poniższym przykładzie:

$ deployer -h mydeployer.mycompany.com -u joeadmin -p password
>>> help

Komenda help pokazana w tym przykładzie jest funkcją Jython.

Procedura

Wywołaj pomoc ogólną.
W przypadku użycia bez nawiasów i bez parametrów komenda help udostępnia ogólną pomoc przy korzystaniu z Cloud Pak System interfejs wiersza komend.
W trybie interaktywnym można wywołać funkcję admin.help bez przedrostka pakietu admin , jak to pokazano w poniższym przykładzie:
```
>>> help
```
Wywołaj pomoc dla pakietu admin .
```
>>> help(admin)
```
Oprócz standardowych bibliotek Jython, interfejs wiersza komend udostępnia bogaty zestaw funkcji i klas w pakietach admin i deployer , które pomagają w zarządzaniu systemem. W przypadku wywołania z parametrem funkcja pomocy udostępnia szczegółowe informacje na temat określonego pakietu, modułu, funkcji lub właściwości. Informacje na temat wywoływania pomocy dla każdego zasobu są dostępne w informacjach dodatkowych dla tego zasobu.
Wywołaj szczegółową pomoc dotyczącą konkretnego tematu.
Przekaz jeden parametr do funkcji pomocy, aby uzyskać bardziej szczegółową pomoc dotyczącą konkretnego tematu. Aby na przykład wyświetlić szczegółową pomoc na temat sposobu pracy z obiektami w chmurze w produkcie interfejs wiersza komend, należy wprowadzić następującą komendę:
```
>>> help(admin.cloud)
```
Przedrostek admin jest używany do grupowania wszystkich funkcji języka Jython specyficznych dla produktu Cloud Pak Systemw jeden pakiet w celu zmniejszenia szans na kolizje nazw z funkcjami i zmiennymi we własnych skryptach.

Wyniki

Wyświetlana jest pomoc szczegółowa lub ogólna.

Co dalej

Użytkownik może nadal używać interfejs wiersza komend z wytycznymi z informacji w funkcji pomocy.