ServiceNow CLI の利用可能なコマンド

ワシントンDC アプリケーションの構築または変更

Release

washingtondc

ft:locale

ja-JP

ft:publication_title

ワシントンDC アプリケーションの構築または変更

ft:clusterId

cadev

bundleId

cadev

workflow

Creator

ServiceNow CLI の利用可能なコマンド

リリースバージョン: Washingtondc

更新日 2024年02月01日

読む13読むのに数分

ベースシステム ServiceNow CLI で使用可能なコマンドとコマンド引数。

グローバルコマンド引数

コマンド引数を使用して、任意の CLI コマンドのオプションを設定します。

--help

説明、サポートされている引数、例を含む、指定されたコマンドのヘルプ情報を提供します。詳細については、「ServiceNow CLI のヘルプ」を参照してください。

$ snc --help

--debug

コマンドの実行時に、デバッグログ記録出力を提供します。詳細については、「ServiceNow CLI のヘルプ」を参照してください。

$ snc record delete --table incident --sysid 552c48888c033300964f4932b03eb092 --debug

--profile

コマンドに使用する名前付きプロファイルを指定します。詳細については、「ServiceNow CLI 接続プロファイルの構成と管理」を参照してください。

$ snc configure profile set --profile <profilename>

--output

コマンドに使用する出力形式を指定します。ServiceNow CLI は次の出力形式をサポートしています。

json：出力は JSON としてフォーマットされます。これがデフォルトです。


{
   "default": {
      "appversion": "1.0.8",
      "host": "https://myinstance.service-now.com",
      "hostversion": "Paris",
      "loginmethod": "basic",
      "output": "json",
      "username": "admin"
   },
   "user1": {
      "appversion": "1.0.8",
      "host": "https://otherinstance.service-now.com",
      "hostversion": "Paris",
      "loginmethod": "basic",
      "output": "yaml",
      "username": "admin"
   }
}

yaml：出力は YAML としてフォーマットされます。YAML を使用して、YAML 形式の文字列を発行または使用するサービスおよびツールで出力を処理します。

default:
   appversion: 1.0.8
   host: https://myinstance.service-now.com
   hostversion: Paris
   loginmethod: basic
   output: json
   username: admin
user1:
   appversion: 1.0.8
   host: https://otherinstance.service-now.com
   hostversion: Paris
   loginmethod: basic
   output: yaml
   username: admin

text：出力は、タブ区切りの文字列値の複数の行としてフォーマットされます。この出力は、grep、sed、awk などの従来の UNIX テキストツールと、PowerShell によって実行されるテキスト処理で使用します。
```
default   https://myinstance.service-now.com   Paris   1.0.8   basic   admin   json 
user1   https://otherinstance.service-now.com   Paris   1.0.8   basic   admin   yaml
```

table：出力は、人間が判読可能な形式で情報が表示されるテーブルとしてフォーマットされます。

NAME   HOST   HOST   VERSION   APP   VERSION   LOGIN   METHOD   USERNAME   OUTPUT 
-------------------------------------------------------------------------------
default   myinstance   Paris   1.0.8   basic   admin   json 
user1   otherinstance   Paris   1.0.8   basic   admin   yaml

none：CLI は出力をコンソールに出力しません。成功、エラー、および進捗状況のメッセージは引き続き表示されます。

$ snc record query --table incident --query ‘active=true’ --output json

--no-interactive

CLI がユーザーに引数値の入力を要求しないようにします。ユーザーが必須引数の値を渡さない場合は、デフォルト値が使用されます。デフォルト値が定義されていない場合は、エラーがスローされます。

--no-verbose

コマンドはメッセージなしでサイレント実行されます。自動テストシナリオでは、この引数を使用します。

プロファイルの設定

接続プロファイルを作成して、インスタンスへの接続、接続プロファイルの表示、接続および利用可能なコマンドの更新、不要になったプロファイルの削除を行います。プロファイルの設定の詳細については、「ServiceNow CLI 接続プロファイルの構成と管理」を参照してください。

デフォルトプロファイルの設定

ServiceNow CLI がデフォルトで使用する接続プロファイルを作成します。インスタンスとの CLI の初期接続を設定するには、デフォルトのプロファイルを作成する必要があります。

$ snc configure profile set

次の情報の入力を求められます。


要求された情報	説明
ホスト	接続するインスタンスのホスト名。完全な URL (https://my-instance.service-now.com) またはホスト名のみ (my-instance) の両方をサポートします。
ログイン方法	インスタンスへの接続に使用するログイン方法。`基本`、`OAuth`、および `OAuth + MFA` をサポートします。
ユーザー名	インスタンスへの接続に使用するユーザー名。
パスワード	インスタンスへの接続に使用するパスワード。
クライアント ID	ログイン方法が OAuth または OAuth + MFA の場合にインスタンスへの接続に使用するクライアント ID。
クライアントシークレット	ログイン方法が OAuth または OAuth + MFA の場合にインスタンスへの接続に使用するクライアントシークレット。
認証コード	ログイン方法が OAuth + MFA の場合にインスタンスへの接続に使用する認証コード。
デフォルトの出力形式	コマンドの結果のフォーマット方法を指定します。オプションは `json`、`yaml`、`text`、および `table` です。

名前付きプロファイルの設定

特定のコマンドで使用する名前付き接続プロファイルを作成します。これにより、特定のコマンドに異なるインスタンスまたは接続プロトコルを指定できます。

$ snc configure profile set [--profile profile-name]

次の情報の入力を求められます。


要求された情報	説明
ホスト	接続するインスタンスのホスト名。完全な URL (https://my-instance.service-now.com) またはホスト名のみ (my-instance) の両方をサポートします。
ログイン方法	インスタンスへの接続に使用するログイン方法。`基本`、`OAuth`、および `OAuth + MFA` をサポートします。
ユーザー名	インスタンスへの接続に使用するユーザー名。
パスワード	インスタンスへの接続に使用するパスワード。
クライアント ID	ログイン方法が OAuth または OAuth + MFA の場合にインスタンスへの接続に使用するクライアント ID。
クライアントシークレット	ログイン方法が OAuth または OAuth + MFA の場合にインスタンスへの接続に使用するクライアントシークレット。
認証コード	ログイン方法が OAuth + MFA の場合にインスタンスへの接続に使用する認証コード。
デフォルトの出力形式	コマンドの結果のフォーマット方法を指定します。オプションは `json`、`yaml`、`text`、および `table` です。

プロファイルの表示

構成ファイルに設定されているすべての接続プロファイルを表示するか、特定のプロファイルに関する情報を表示します。

$ snc configure profile list [--profile profile-name]

プロファイルの削除

不要になった名前付き接続プロファイルを構成ファイルから削除します。

$ snc configure profile remove [--profile profile-name]

プロファイルのリフレッシュ

指定されたプロファイルのインスタンスから利用可能なコマンドを更新します。CLI を最新の状態に保つために、対応するインスタンスのいずれかのコマンドを変更した後は接続を更新します。

$ snc configure profile refresh [--profile profile-name]

レコード操作の実行

ServiceNow CLI コマンドラインツールを使用して、インスタンスのレコードの作成、読み取り、更新、削除、クエリを行います。レコード操作の実行の詳細については、「 ServiceNow CLI を使用したレコード操作の実行」を参照してください。

レコードを作成

指定されたテーブルに単一のレコードを挿入します。

$ snc record create [--table table --data data]

これらの引数に値を渡します。


パラメーター	説明
table	必須です。レコードを保存するテーブルの名前。
data	必須です。指定されたレコードで JSON 文字列形式で定義するフィールド名と各フィールドの関連値。

レコードの削除

指定されたテーブルから指定されたレコードを削除します。

$ snc record delete [--table table --sysid sys_id]

これらの引数に値を渡します。


パラメーター	説明
table	必須です。レコードを削除するテーブルの名前。
sysid	必須です。削除するレコードの sys_id。

レコードの取得

指定された sys_id に基づいて指定されたテーブルから単一のレコードを取得します。

$ snc record get [--table table --sysid sys_id]

これらの引数に値を渡します。


パラメーター	説明
table	必須です。レコードの取得元のテーブルの名前。
sysid	必須です。取得するレコードの sys_id。

レコードのクエリ

指定されたテーブルから複数のレコードを取得します。

$ snc record query [--displayvalue displayValue --fields fields --limit limit --offset offset --query query --table table]

これらの引数に値を渡します。


パラメーター	説明
displayValue	参照フィールドと選択フィールドの表示値をデータベースから取得するには、`--displayvalue` を含めます。実際の値を取得するためにこのパラメーターを含めないでください。
フィールド	データベースから返すカンマで区切られたフィールド名のリストです。
limit	返されるレコードの最大数。
offset	レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。
クエリ	必須です。次の形式で結果セットをフィルタリングするために使用されるエンコードされたクエリ： `--query '<column_name><operator><value>'`
table	必須です。レコードのクエリを実行するテーブルの名前。

レコードを更新

指定されたレコードを指定されたデータ属性で更新します。

$ snc record update [--sysid sys_id --table table --data data]

これらの引数に値を渡します。


パラメーター	説明
table	必須です。レコードを保存するテーブルの名前。
sysid	必須です。更新するレコードの sys_id。
data	必須です。指定されたレコードで JSON 文字列形式で定義するフィールド名と各フィールドの関連値。

拡張の操作

ServiceNow CLI に拡張を追加して、追加の機能やコマンドをロードしたり、既存の拡張を更新したり、不要になった拡張を削除したりします。詳細については、「ServiceNow CLI 拡張の管理」を参照してください。

利用可能な拡張の検索

$ snc extension list-available -o table

拡張のインストール

$ snc extension add --name <extension-name>

拡張の更新

$ snc extension update --name <extension-name>

拡張の削除

$ snc extension remove --name <extension-name>

UI コンポーネント拡張の使用

UI コンポーネント拡張の追加

UI コンポーネントエクステンションを ServiceNow CLI に追加します。

$ snc extension add --name ui-component

プロジェクトの設定

コンポーネントプロジェクトと、コンポーネントの開発に必要なファイルのセットを作成します。インスタンスに接続してコンポーネントのアプリケーションスコープを作成するか、後で検証するためにスコープを予約することができます。

$ snc ui-component project [--name name --description description --scope scope --offline]

これらの引数に値を渡します。


名前	説明
name	必須です。プロジェクト名。有効な一意の npm パッケージ名である必要があります。
説明	npm レジストリとインスタンスのプラグインリストで使用できるプロジェクトの説明。
scope	このプロジェクトとそのコンポーネントにアサインする提案されたアプリケーションスコープ。指定されている場合、インスタンスは名前を検証します。インスタンスでのアプリケーション開発には、名前空間識別子のガイドラインを使用します。詳細については、「アプリケーションスコープ」を参照してください。最大：18 文字。ケース：スネークケース。デフォルト：`x_customerprefix_componentname`、ここで： `customerprefix` は、インスタンスの glide.appcreator.company.code システムのプロパティの値です。 `componentname` は、プロジェクトの作成時にコンポーネントの `name` パラメーターで指定された値です。または、now-ui.json ファイルで `scopeName` パラメーターに値を追加することもできます。詳細については、「コンポーネントのアプリケーションスコープの変更」を参照してください。
offline	true の場合、インスタンスから切断されている間にコンポーネントを作成してスキャフォールディングします。指定されたスコープ名の検証をスキップします。デフォルト値：`false`。

開発サーバーの実行

コンポーネントコードを追加し、ローカルの開発サーバーを使用してテストします。

$ snc ui-component develop [--entry entry --open --port port --host host]

これらの引数に値を渡します。


名前	説明
エントリー	コンポーネントプロジェクト内のテストモジュールへのパス。デフォルト： example/index.js。
open	デフォルトのブラウザーを開き、テストページに移動します。デフォルト値：false。
port	開発サーバーが実行されているポート。デフォルト：8081。
host	ローカル開発サーバーを他のユーザーが外部からアクセスできるようにする場合に使用するホストアドレス。通常は `0.0.0.0` に設定します

インスタンスへのコンポーネントの展開

アプリケーションプラグインとしてインスタンスに表示するコンポーネントを展開します。

$ snc ui-component deploy [--open --force]

これらの引数に値を渡します。


名前	説明
open	true の場合、デフォルトのブラウザーが開き、インスタンスの UI ビルダーに移動します。デフォルト値：false
force	コンポーネントの変更を展開し、既存のコンポーネントレコードを上書きします。デフォルト値：false。