サービスCLIの使用

「サービスCLI」の使用

ドキュメント内の「サービスCLI」と呼ばれる「サービス・エンクレーブ」へのコマンドライン・インタフェースは、管理ノードのOracle Linuxシェルを介して使用できます。追加のインストールまたは構成は必要ありません。 CLIでは、「サービスWeb UI」のすべての機能に加え、UIに相当するものがないいくつかの追加操作にアクセスできます。

この項では、「サービスCLI」を使用するための一般的なガイドラインを示します。実際のコマンドとその機能は、以降の章のステップの一部として、「Oracle Private Cloud Appliance管理者ガイド」全体に説明されています。

CLIへのアクセス

「サービスCLI」にアクセスするには、次のいずれかのノードでTCPポート30006へのSSH接続を確立し、認可された管理者としてログインします:

管理ノードの1つ。

$ ssh admin@pcamn02 -p 30006
Password authentication
Password:
PCA-ADMIN>

Private Cloud Appliance。

$ ssh admin@admin.pca_hostname.example.com -p 30006

認証に成功すると、対話型のクローズド・シェル環境で、PCA-ADMIN>プロンプトでコマンドを入力して管理操作を実行します。

CLIセッションを終了するには、exitコマンドを入力します。

コマンドの構文および完了関数については、以降のセクションで説明します。

コマンド構文

通常、「サービスCLI」に入力されたコマンドの構文は次のとおりです:

PCA-ADMIN> command objectType <attributes> [options]

説明:

commandは、開始されるコマンド・タイプです。たとえば: listまたはcreate。
objectTypeは、コマンドによって影響を受けるターゲット・コンポーネントまたはプロセスです。たとえば: list ComputeNodeまたはcreate Tenant。
attributesは、コマンドを適用する必要がある、選択したタイプの特定のオブジェクトの識別に使用されるプロパティです。たとえば、: show ManagementNode name=pcamn02。
optionsは、コマンドの動作に影響を与える可能性がある追加パラメータです。

たとえば、ソートおよびフィルタ・オプションをlistコマンドに追加し、表示するデータ列(フィールド)を選択できます: list RackUnit fields ipAddress,name,rackElevation,serialNumber,firmwareVersion where state eq running。

コマンドの主な要素はスペースで区切られます。属性は"type=value"として指定されます。リストは、カンマ区切りの一連の値(fields ipAddress,name,rackElevation,serialNumber,firmwareVersionなど)として入力されます。

ヘルプとコマンドの完了

「サービスCLI」には、helpコマンドが含まれます。最も一般的なタイプのコマンドがどのように使用されるかを示しています。これは、CLIの基本を理解するのに役立ちます。

PCA-ADMIN> help
For Most Object Types:
    create <objectType> [(attribute1)="value1"] ... [on <objectType> <instance>]
    delete <objectType> <instance>
    edit <objectType> <instance>  (attribute1)="value1" ...
    list <objectType> [fields (attribute1,attribute2)]where [(filterableAttribute1)  \
         <filterComparator> "value1" [AND|OR] [(filterableAttribute2) <filterComparator> "value2"
    show <objectType> <instance>
For Most Object Types with Children:
    add <objectType> <instance> to <objectType> <instance>
    remove <objectType> <instance> from <objectType> <instance>
Other Commands:
    exit
    showallcustomcmds
    showcustomcmds <objectType>
    showobjtypes

使用可能なコマンドとオブジェクト・タイプを学習する最も簡単な方法は、疑問符("?")を使用することです。ログイン後、CLIプロンプトで"?"と入力して、ベース・コマンドのセットを表示します。

PCA-ADMIN> ?
           add
           clear
           count
           create
           delete
           edit
           [...]

コマンド、オブジェクト・タイプおよびその他の要素にドリルダウンするには、"?"を追加して、そのカーソル位置で使用可能なパラメータを確認します。

ノート:

疑問符の位置: コマンドからスペースで区切られます。スペースを省略した場合、CLIは、コマンドのあとに続くパラメータではなく、そのコマンドのレベルで許可されるパラメータを表示します。

たとえば、リストできるオブジェクト・タイプを確認する場合は、list ?と入力してEnterを押します。次に、まだプロビジョニングされていないコンピュート・ノードを検索するとします。これを実現するために、プロビジョニング状態でフィルタされたコンピュート・ノードのリストを表示できます。 "?"を使用すると、次のようにコマンド・パラメータ間を移動できます。 "?"と入力するたびに、CLIにはカーソル位置で使用できるパラメータが表示されます。上矢印キーを押して、プロンプトですでに入力したコマンドの一部に戻り、コマンドの次の部分を追加し、もう一度"?"と入力して次のパラメータ・セットを表示します。コマンドが完了したら、Enterキーを押します。

PCA-ADMIN> list ?
                AuthorizationGroup
                ComputeNode
                Event
                Fault
                [...]
PCA-ADMIN> list ComputeNode ?
                            fields
                            limit
                            orderby
                            where
PCA-ADMIN> list ComputeNode where ?
                                  id
                                  provisioningState
                                  provisioningStateLastChangedTime
                                  provisioningType
                                  faultDomain
                                  [...]
PCA-ADMIN> list ComputeNode where provisioningState ?
                                                    EQ
                                                    NE
                                                    LIKE
                                                    [...]
PCA-ADMIN> list ComputeNode where provisioningState EQ ?
                                                       READYTOPROVISION
                                                       PROVISIONED
PCA-ADMIN> list ComputeNode where provisioningState EQ READYTOPROVISION
Command: list ComputeNode where provisioningState EQ READYTOPROVISION
Status: Success
Time: 2021-06-25 14:04:16,837 UTC
Data:
  id                                     name       provisioningState
  --                                     ----       -----------------  
  bb940637-9825-4f7c-a5f4-1b49bcf6a5c9   pcacn005   Ready To Provision
  76df44a9-6980-4242-a3a2-e1614b3d44d1   pcacn008   Ready To Provision
  8fc0d06f-c64a-40ea-8a20-89680f03eb5e   pcacn011   Ready To Provision

「サービスCLI」には、タブ補完の形式も用意されています。コマンドを入力してTabキーを押すと、CLIは予測できる部品を自動補完します。複数の可能な値が残っている場合は、少なくとも1文字を追加し、Tabキーを再度押す必要があります。次の例は、CLIがタブ補完を実行する方法を示しています。

1つの一致が可能なタブ完了

PCA-ADMIN> list Com<Tab>
PCA-ADMIN> list ComputeNode

複数の一致が可能なタブ補完

PCA-ADMIN> list Ra<Tab>
PCA-ADMIN> list Rack

PCA-ADMIN> list RackU<Tab>
PCA-ADMIN> list RackUnit

基本コマンドとカスタム・コマンド

helpコマンドを入力するか、PCA-ADMIN>プロンプトで疑問符("?")を入力すると、CLIはその基本コマンド(create, edit, add, remove, delete, list, showなど)に関する情報を返します。ただし、一般的に使用される「カスタム・コマンド」のもう1つのセットがあります。すべてを単一のリストとして表示することも、特定のオブジェクト・タイプで使用可能なもののみ表示することもできます。 "?"を使用してコマンド間を移動できます。

PCA-ADMIN> showallcustomcmds
Operation Name: <Related Object(s)>
    -----------------------------------
    asrClientDisable:  ASRPhonehome
    asrClientEnable:  ASRPhonehome
    asrClientRegister:  ASRPhonehome
    [...]
    changeIlomPassword:  ComputeNode, ManagementNode
    changePassword:  ComputeNode, LeafSwitch, ManagementNode, ManagementSwitch, SpineSwitch, User, ZFSAppliance
    clearFirstBootError:  NetworkConfig
    configZFSAdDomain:  ZfsAdDomain
    configZFSAdWorkgroup:  ZfsAdDomain
    createAdminAccount:  
    createUserInGroup:  User
    deletePlatformImage:  PlatformImage
    deprovision:  ComputeNode
    disableVmHighAvailability:  PcaSystem
    drAddComputeInstance:  ComputeInstance
    drAddSiteMapping:  DrSiteMapping
    drConfigCleanupPrimary:  DrConfig
    [...]
    maintenanceLock:  ComputeNode
    maintenanceUnlock:  ComputeNode
    migrateVm:  ComputeNode
    patchCN:  PatchRequest
    patchEtcd:  PatchRequest
    patchHost:  PatchRequest
    patchIlom:  PatchRequest
    patchKubernetes:  PatchRequest
    patchMySQL:  PatchRequest
    patchOCIImages:  PatchRequest
    patchPlatform:  PatchRequest
    patchSwitch:  PatchRequest
    patchVault:  PatchRequest
    patchZfssa:  PatchRequest
    [...]
    start:  CnUpdateManager, ComputeNode, Day0NetworkConfigManager, FaultManager, PurgeManager, ZfsPoolManager
    stop:  CnUpdateManager, ComputeNode, Day0NetworkConfigManager, FaultManager, PurgeManager, ZfsPoolManager
    syncHardwareData:  
    syncUpstreamUlnMirror:  PatchRequest
    systemStateLock:  PcaSystem
    systemStateUnlock:  PcaSystem
    updateSauronCredentials:  
    upgradeCN:  UpgradeRequest
    upgradeEtcd:  UpgradeRequest
    upgradeFullMN:  UpgradeRequest
    upgradeHost:  UpgradeRequest
    upgradeIlom:  UpgradeRequest
    upgradeKubernetes:  UpgradeRequest
    upgradeMySQL:  UpgradeRequest
    upgradePlatform:  UpgradeRequest
    upgradePreConfig:  UpgradeRequest
    upgradeSwitch:  UpgradeRequest
    upgradeVault:  UpgradeRequest
    upgradeZfssa:  UpgradeRequest

PCA-ADMIN> showcustomcmds ?
                          ASRBundle
                          ASRPhonehome
                          BackupJob
                          CnUpdateManager
                          ComputeInstance
                          ComputeNode
                          Day0NetworkConfigManager
                          DrConfig
                          DrJob
                          DrSiteMapping
                          Event
                          ExadataNetwork
                          FaultDomainInfo
                          FaultManager
                          Job
                          LeafSwitch
                          ManagementNode
                          ManagementSwitch
                          NetworkConfig
                          PatchRequest
                          PcaSystem
                          PlatformImage
                          PurgeManager
                          SpineSwitch
                          UpgradeJob
                          UpgradeJobList
                          UpgradeRequest
                          User
                          Vcn
                          ZfsAdDomain
                          ZFSAppliance
                          ZfsPoolManager

PCA-ADMIN> showcustomcmds ComputeNode
    provisioningLock
    provisioningUnlock
    maintenanceLock
    maintenanceUnlock
    provision
    deprovision
    migrateVm
    reset
    start
    stop
    changePassword
    changeIlomPassword
    getRunningInstances
    getRunningInstancesCount