REST API Usage RBAC Usage

Command Line Interface (CLI)

K2HR3 Command Line Interface(CLI)は、K2HR3が提供するREST APIをコマンドラインから操作できるインターフェースを提供します。
K2HR3システムのもつデータを操作する K2HR3 Webアプリケーション と同等の機能を コマンドラインインターフェース として提供します。

概要

K2HR3 Command Line Interface(CLI) を使うには、パッケージでインストールするか、ソースコードを展開することで利用できます。
K2HR3 Command Line Interface(CLI)は、K2HR3 REST APIを利用しますので、REST APIサーバーに接続可能なホスト上で動作することができます。

使い方

K2HR3 Command Line Interface(CLI)は、ひとつのコマンド(k2hr3)として提供されます。
使い方は、--help(-h)を渡してヘルプを表示できます。

$ k2hr3 --help
$ k2hr3 <sub command> --help

インストール(パッケージ)

K2HR3 Command Line Interface(CLI)をパッケージとしてインストールする方法を説明します。

K2HR3 Command Line Interface(CLI)は、packagecloid.io でパッケージを頒布しています。
K2HR3 Command Line Interface(CLI)は、Bourne Shell/bin/sh)およびcurlが動作できる環境で利用できます。
以下の手順でインストールできます。

パッケージリポジトリの設定

インストール前に、packagecloid.io のリポジトリを設定してください。
ここを参考にして、リポジトリを登録します。

# curl -s https://packagecloud.io/install/repositories/antpickax/stable/script.deb.sh | sudo bash
 もしくは
# curl -s https://packagecloud.io/install/repositories/antpickax/stable/script.rpm.sh | sudo bash

パッケージのインストール

以下のようにパッケージ管理ツールを使い、インストールします。

# apt-get install k2hr3-cli
 もしくは
# yum install k2hr3-cli

ソースコード

パッケージが提供されていないOSや、パッケージを使わず利用する場合には、github.comリポジトリ から直接ソースコードをダウンロードして利用することができます。
github.comおよびgitコマンドの使い方については、ドキュメントなどを参照してください。

ソースコードを展開して、利用する場合には、以下の環境変数を設定する必要があります。

$ export K2HR3CLI_LIBEXEC_DIR <k2hr3_cli repository top dir>/src/libexec

K2HR3 Command Line Interface(CLI)のコマンド(k2hr3)は、<k2hr3_cli repository top dir>/src/k2hr3にありますので、このファイルを実行してください。

詳細

K2HR3 Command Line Interface(CLI)の使い方を説明します。

共通

K2HR3 Command Line Interface(CLI)のコマンドの書式を以下に示します。

$ k2hr3 --help(-h)
 もしくは
$ k2hr3 <sub command> <options...>

サブコマンド(****)は、各K2HR3 REST APIに対応しています。(後述)

ヘルプ表示

K2HR3 Command Line Interface(CLI)の使い方は、以下のようにヘルプで見ることができます。

$ k2hr3 --help(-h)

上記のように、サブコマンド(****)なしで、ヘルプを表示させるとK2HR3 Command Line Interface(CLI)の概要を表示します。

各サブコマンドのヘルプを表示するには、以下のように実行します。

$ k2hr3 <sub command> --help(-h)

各サブコマンド(****)の使い方が表示されます。

オプション

K2HR3 Command Line Interface(CLI)には、いくつかのオプションがあります。
各オプションの説明は、こちらを参照してください。
サブコマンドに応じて、指定できるオプションは異なりますので、各サブコマンドの説明を参照してください。

サブコマンド

K2HR3 Command Line Interface(CLI)のサブコマンドの説明をします。

config

K2HR3 Command Line Interface(CLI)のコンフィグレーションに関連する操作を行うサブコマンドです。
K2HR3 Command Line Interface(CLI)は、いくつかのオプションで指定する値をコンフィグレーションファイルに保持することができます。
これにより、連続してコマンドを実行するときに、これらのオプションを指定せず、コンフィグレーションに保存した値を使うことができます。

version

VERSION APIに対応したサブコマンドです。
K2HR3 REST APIのバージョンを表示するサブコマンドです。

token

K2HR3 REST APIを使うために必要となるトークンを操作するためのサブコマンドです。
これは、TOKEN APIに対応したサブコマンドです。

list

LIST APIに対応したサブコマンドです。
K2HR3のロール(ROLE)、ポリシー/ルール(POLICY)、リソース(RESOURCE)のパスリストを表示するサブコマンドです。

role

ROLE APIに対応したサブコマンドです。
K2HR3のロール(ROLE)を操作するサブコマンドです。

policy

POLICY APIに対応したサブコマンドです。
K2HR3のポリシー/ルール(POLICY)を操作するサブコマンドです。

resource

RESOURCE APIに対応したサブコマンドです。
K2HR3のリソース(RESOURCE)を操作するサブコマンドです。

service

SERVICE APIに対応したサブコマンドです。
K2HR3のサービス(SERVICE)を操作するサブコマンドです。

acr

ACR(ACCESS CROSS ROLE) APIに対応したサブコマンドです。
K2HR3の+サービス(+SERVICE)機能で利用するACR(ACCESS CROSS ROLE)を操作するサブコマンドです。

userdata

USERDATA APIに対応したサブコマンドです。
K2HR3のUSER DATA SCRIPTを操作するサブコマンドです。

extdata

EXTDATA APIに対応したサブコマンドです。
K2HR3のEXT(RA) DATA SCRIPTを操作するサブコマンドです。

REST API Usage RBAC Usage