モデル

内容
casp1041
内容
モデルの作成または削除およびモデル属性の読み取りまたは変更には、model リソースを使用します。 このセクションでは、モデル作成の例を示します。 詳細については、「モデル タイプに基づくモデルの作成例」を参照してください。
model リソースは、一度に 1 つのモデルで動作します。 モデルのグループの場合は、models リソースを使用します。
  • ベース URL
    http://<hostname><:portnumber>/spectrum/restful/model
POST model
POST model を使用すると、新しいモデルを作成し、指定したモデルのリスト属性を更新できます。
新しいモデルの作成
POST model は、新しいモデルを作成してモデル ハンドルを返します。
  • URL
    http://<hostname><:portnumber>/spectrum/restful/model[?landscapeid=<landscape_handle>][&mtypeid=<mtype_handle>][&agentport=<snmp_port>][&commstring=<comm_str>][&retry=<retry_cnt>][&timeout=<timeout_val>][&ipaddress=<ip_address>][&parentmh=<model_handle>][&relationid=<rel_handle>][&attr=<attr_id>&val=<num>]
  • HTTP メソッド
    POST
  • ボディ
    なし
  • ボディ コンテンツ
    使用されません
  • ヘッダ
    application/xml、application/json
  • 出力
    作成されたモデルのモデル ハンドルまたはモデルを作成できなかった場合はエラーを示す、XML または JSON 形式の一覧。
URL パラメータ
  • &landscapeid=<
    landscape_handle
    >
    (オプション)モデルを作成するランドスケープを指定します。
  • &mtypeid=<
    mtype_handle
    >
    (オプション)作成するモデルのモデル タイプ ハンドルを指定します。 ipaddress パラメータを指定しない場合は必須です(後述)。
  • &agentport=<
    snmp_port
    >
    (オプション)デバイスの SNMP 管理ポートを指定します。
    デフォルト:
     161
  • &commstring=<
    comm_str
    >
    (オプション)コミュニティ文字列を指定します。
    デフォルト:
    public
  • &retry=<
    retry_cnt
    >
    (オプション)再試行回数を指定します。
    デフォルト:
    3
  • &timeout=<
    timeout_val
    >
    (オプション)タイムアウト値を指定します。
    デフォルト:
    3000
  • &ipaddress=<
    ip_address
    >
    (オプション) IP アドレスを指定します。
  • &parentmh=<
    model_handle
    >
    (オプション)親(関連付けの左側)モデルを指定します。
  • &relationid=<
    rel_handle
    >
    (オプション)親からこのモデルへの関連付けを指定します。
    デフォルト:
    Collects
  • &attr=<
    attr_id
    >&val=<
    num
    >
    (オプション)属性の ID と値を指定します。
指定されたモデルのリスト属性の更新
以下の POST model は、指定されたモデルのリスト属性を更新します。
  • URL
    http://<hostname><:portnumber>/spectrum/restful/model/attr/update
  • HTTP メソッド
    POST
  • ボディ
    XML
  • ボディ コンテンツ
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <update-model-attrlist-request xmlns="http://www.ca.com/spectrum/restful/schema/request"> <model mh="<model_handle>"/> <attribute-list id="<attribute_id>"> <instance oid="<instance_id_0>" value="<value>"/> <instance oid="<instance_id_1>" value="<value>"/> </attribute-list> </update-model-attrlist-request>
  • 本体のパラメータ
    <model mh="<model_handle>"/>
    更新するモデルを指定します。
    <attribute-list id="<attribute_id>">
    更新する属性 ID を指定します。
    <instance oid="<instance_id_0>" value="<value>"/>
    更新するインスタンス ID および値を指定します。
    インスタンス ID タグを繰り返して、リスト属性内の複数のインスタンスを更新します。
  • ヘッダ
    application/xml、application/json
  • 出力
    更新されたモデルのモデル ハンドルまたはモデルを更新できなかった場合はエラーを示す、XML 形式の一覧。
GET model
GET model は、指定したモデルから属性を読み取ります。
  • URL
    http://<hostname><:portnumber>/spectrum/restful/model/<model_handle>[?attr=<attr_ID>]
  • HTTP メソッド
    GET
  • ボディ
    なし
  • ボディ コンテンツ
    使用されません
  • ヘッダ
    application/xml、application/json
  • 出力
    要求された属性の XML または JSON 形式の一覧
URL パラメータ
  • model_handle
    モデルを指定します。
  • &attr=<
    attr_ID
    >
    (オプション)要求する属性を指定します。 複数の属性パラメータを指定できます。
PUT model
PUT model は、指定したモデルの属性を更新します。
  • URL
    http://<hostname><:portnumber>/spectrum/restful/model/<model_handle>?attr=<attr_ID>&val=<num>
  • HTTP メソッド
    PUT
  • ボディ
    なし
  • ボディ コンテンツ
    使用されません
  • ヘッダ
    application/xml、application/json
  • 出力
    要求された属性の XML または JSON 形式の一覧
URL パラメータ
  • model_handle
    更新するモデルを指定します。
  • &attr=<
    attr_ID
    >&val=<
    num
    >
    更新する属性と値を指定します。 複数の属性値のペアを指定することができます。
DELETE model
DELETE model は、指定したモデルを削除します。
  • URL
    http://<hostname><:portnumber>/spectrum/restful/model/<model_handle>
  • HTTP メソッド
    DELETE
  • ボディ
    なし
  • ボディ コンテンツ
    使用されません
  • ヘッダ
    application/xml、application/json
  • 出力
    成功または失敗を示す XML または JSON のリスト
URL パラメータ
  • model_handle
    削除するモデルを指定します。