APM CLI設定ステートメント

自動再生(APM)

構文

階層レベル

説明

プールを自動的にドレインし、他のプールで使用するためにプレフィックスを回復するようにAPMを設定します。

注:

auto-reclamationスタンザを設定することでauto-reclamationを有効にすることができます。auto-reclamationスタンザを設定する際には、少なくとも1つのアクティブオプション(alwaysまたはwindow)で設定する必要があります。

注:

APM は、構成から auto-reclamation を削除すると、保留中のすべてのドレインおよび回復トランザクションをキャンセルします。

オプション

active (always | window)

自動レクラメーションがアクティブになるタイミングを指定します。

  • always—APMは、重要なプールまたはアイドル状態のプールを常に評価して、再利用を開始するかどうかを決定します。

  • window—APM は、 window-start オプションと window-duration オプションで定義した時間枠内にのみ、再利用のためにプールを評価します。これらのオプションのいずれかが 0 に設定されている場合、APM は always オプションを設定したかのように動作します。

    注:

    プールは、以下の両方が発生した場合、ウィンドウの有効期限が切れた後に再利用されます。

    • プールの排水は開始されますが、時間枠中は完了しません。これは、プールにまだいくつかのアドレスがあるため、アイドルではないことを意味します。

    • プールは引き続き排水され、ウィンドウが終了するとアイドル状態になります。

    注:

    プールがアイドル状態の場合、プールは窓の外に再生されます。

  • デフォルト: always

window-duration minutes

APM がプールを評価して再利用を開始するための window-start 時間からウィンドウが開いている時間 (分単位) を指定します。

  • デフォルト: 60分

  • 範囲: 15〜720分

window-start time-offset

UTCオフセットを含むクラスターのローカル時間を使用して、ウィンドウの開始時間を指定します。例えば、クラスターノードが -5 時間の UTC オフセットを使用するように設定されていて、自動再生ウィンドウを午前 4:00 に開始する場合は、ウィンドウ開始時刻を 04:00-0500 に設定します。

リリース情報

APMリリース3.0.0で導入されたステートメント。

エンティティマッチ(APM)

構文

階層レベル

説明

エンティティ一致リストを設定して、有効なBNGをプールドメインプロファイルにマッピングします。

entity-matchステートメントが識別します。entity-match ステートメントは、受信する APM エンティティをプールドメインプロファイルに誘導します。APMは、2つのリストが一致するように、プールドメインをBNGのリストと調整します。調整中にドメインが削除された場合、関連するプールプレフィックスが元のパーティションに戻されます。調整の終了時にドメインが空の場合、APM と BNG の両方がリストからプール ドメインを削除します。APMエンティティ(システムIDで識別される)がエンティティ一致リストに存在しない場合、接続は許可されず、接続は中止されます。

オプション

entity-match system-id

エンティティのシステムIDを指定します。システムIDは、マネージドBNGに割り当てられた最大45文字の一意の文字列です。これは、接続が成功したときにAPMへのエンティティを識別するために使用されます。

pool-domain-profile domain-profile-name

このシステムに使用するプールドメインプロファイル。

inet-pool(APM)

構文

階層レベル

説明

APMがIPv4アドレスのグローバルプールをパーティション化する方法と、個々のBNGプールドメインにアドレスを割り当てる方法を設定します。 inet-pool ステートメントで定義されたアドレスプールは、割り当てコンテキストを定義するために作成する複数のパーティションで構成されています。パーティションごとに複数のルートプレフィックスを設定します。パーティションに有効なルートプレフィックスの最小サイズと最大サイズを指定できます。APM が特定のルートプレフィックスから分割できる最小のサブネットワークを指定します。APMは、ルートプレフィックスを細分化し、必要に応じて結果のサブネットワークを個々のプールドメインに割り当てて、ドメインの利用可能なアドレスを補います。

オプション

partition partition-name パーティションの名前を設定します。
free-prefix-utilization percentage

パーティション内の未割り当てプレフィックスの最小しきい値の割合を設定します。パーセンテージがこの値を下回ると、パーティションの使用可能なアドレスが少なくなっていることを示す警告メッセージが生成されます。通知は情報を提供するのみであり、他のアクションはトリガーされません。

  • デフォルト: 10

  • 範囲: 0〜100

max-prefix-length max-prefix-length

このパーティションで有効なルートプレフィックスのサイズを定義します。この設定では、このパーティションのルートプレフィックスの有効なプレフィックス長の上限を設定します。この上限は、割り当てるホストアドレスが最も少ないルートプレフィックスを定義します。プレフィックス長が長くなると、APM はルート プレフィックスから分割できる従属プレフィックスの数を減らすことができます。

  • デフォルト: 24

  • 範囲: 1〜31

max-prefix-len値は、サブネットワークを定義する際に使用される最大ビット数です。min-prefix-len値以上である必要があります。それ以外の場合、APMはプレフィックスをパーティションに追加しません。

min-prefix-len min-prefix-length

このパーティションで有効な最大サイズのサブネットワークを定義します。この設定では、このパーティションのルート プレフィックスの有効なプレフィックス長の下限を設定します。この下限は、割り当てるホストアドレスが最も多いルートプレフィックスを定義します。プレフィックス長が短くなると、APMはルートプレフィックスからより多くの従属プレフィックスを分割できます。

  • デフォルト: 8

  • 範囲: 1〜31

min-prefix-len値は、max-prefix-len値以下である必要があります。それ以外の場合、APMはプレフィックスをパーティションに追加しません。

role パーティションの役割。ロールが設定されていない場合、デフォルトでoriginが引き継がれます。ロールは次のいずれかです。
  • origin—APMがプールドメインにアドレスを割り当てる送信元パーティション。

  • backup—関連するオリジンパーティションが枯渇したときにAPMがプールドメインにアドレスを割り当てるバックアップパーティション。

backup-partition partition-name APM がプール ドメインにアドレスを割り当てるバックアップ パーティションの名前。 backup-partition ステートメントは、以下の要件が満たされている場合にのみ設定できます。
  • パーティションの役割は originです。

  • バックアップパーティションは設定内に存在します。

  • バックアップパーティションと元パーティションの min-prefix-len と max-prefix-len が一致します。

  • バックアップパーティションのプレフィックスは、送信元のプレフィックスと重複しません。

  • バックアップパーティションの役割はバックアップに設定されています。

prefix ip-address パーティションのルートプレフィックスを指定します。APMは、このルートからサブネットワークを分割して、BNGのプールドメインのアドレスをプロビジョニングします。ルートプレフィックス長は、パーティションレベルの min-prefix-len と max-prefix-len オプションの値で定義された範囲内でなければなりません。通常、パーティションごとに複数のルートプレフィックスを設定します。
  • max-prefix-length max-prefix-length—ルートプレフィックスの粒度と、APMが指定されたルートプレフィックスから分割できる最小プレフィックスを定義します。プレフィックス長が長くなると、サブネットワークのサイズは小さくなります。
    • デフォルト: 24

    • 範囲: 1〜31

  • prefix-recycle-hold seconds—割り当てに使用できるようになるまで、APM が再利用されたプレフィックスを保持する期間を秒単位で指定します。
  • route-tag tag—ルーターがプレフィックスの静的破棄ルートを作成する際にルートに関連付けるルートタグとして使用する番号のリストを指定します。APM は、ルート プレフィックスからサブプレフィックスが割り当てられるたびに、ラウンドロビン方式でルート タグ リストを循環します。
  • 範囲: 5〜300

リリース情報

APMリリース3.0.0で導入されたステートメント。

プールドメインプロファイル(APM)

構文

階層レベル

説明

割り当て中にBNG上にプールドメインを作成するために使用するプールドメインプロファイルを設定します。プロファイルは、割り当てるプレフィックスの数、BNGが監視するしきい値、自動再利用がアクティブかどうかを指定します。

オプション

pool-domain-profile domain-profile-name プールドメインプロファイル名。
monitoring

プールドメインとプールドメイン内のプールがアドレスをどのように使用しているかを監視するための属性を設定します。空き(利用可能)アドレスと使用済み(割り当て済み)アドレスのしきい値は、APMがアラームを生成するポイントを確立します。

  • apportion-threshold apportion-threshold-count—プロビジョニングイベントをトリガーするプールドメインで使用可能なアドレスの最小数を設定します。
  • reclaim-threshold reclaim-threshold-count—このプロファイルから作成されたプールドメインの再利用しきい値を設定します。再利用ホールドダウンが無効(0に設定)されている場合、APMは設定された再利用しきい値を計算されたしきい値と比較し、より大きい方の値を使用します。計算されたしきい値は、計算されたしきい値 = apportion-threshold + (prefix-count * 2^(32 – preferred-prefix-len)) + 1 の式から導き出されます。
  • reclamation-hold-down—エンティティが割り当てイベント後にプールドメインの潜在的なイベントを中断する期間を秒単位で設定します。ゼロ以外の再利用ホールドダウン値を設定することで、プールドメインがアイドル状態の場合に役立つ可能性のある低い reclaim-threshold 値を設定できます(その結果、エンティティに残る割り当てプールプレフィックスが少なくなります)。複数のプレフィックスを再利用するアロケーションイベントは、空きアドレスの数を一時的に再利用しきい値以上に押し上げることがあるため、指定した時間だけ再利用イベントを抑制することで、加入者ログインレートが割り当てられたプレフィックスセットに追いつくことができます。割り当てイベントがプールドメインにアドレスを追加し、プールドメインの空きアドレス数が再利用しきい値を上回る場合、空きアドレスの数が再利用しきい値を下回るまで再利用イベントの生成を停止します。
    • デフォルト: 0

      値が0の場合、 hold-down timer は無効になります。

    • 範囲: 1〜3600

      注:

      reclamation-hold-downが30秒から3600秒の間に設定されている場合に有効になり、APMはreclaim-thresholdを設定した値に戻します。reclamation-hold-downが有効か無効かに関係なく、APM はDOMAIN_THRESHOLDS_CHANGEトリガー応答を通じて影響を受けるエンティティに変更を通知します。

いくつかのステートメントは別途説明します。詳細については、構文セクションのリンクされたステートメントをクリックします。

リリース情報

APMリリース3.0.0で導入されたステートメント。

reclamation-hold-down 3.1.0 で導入されたオプション

システム(APM)

構文

階層レベル

説明

アラームとトランザクションに対して APM がどのように動作するかを決定する属性を設定し、APM への接続が許可される APMi エンティティの数を定義します。

オプション

transaction-time-out seconds

(オプション)APM がトランザクションの停止 (タイムアウト) を宣言する前に、トランザクションが完了するまで待機する時間を指定します (秒単位)。トランザクションは、タスクのリストで構成されます。例えば、配分トランザクションは、アドレスを取得するタスク、エンティティをプロビジョニングするタスク、およびランタイム状態を更新するタスクで構成されます。トランザクション内のタスクが失敗すると、リスト内の以前に実行されたタスクがロールバックされます。たとえば、プロビジョニングタスクが失敗した場合、アドレスを取得するタスクはロールバックされ、アドレスはパーティションに返されます。

  • デフォルト: 240

  • 範囲: 60〜900

max-clients <0..500>

APMサーバーへの接続が許可されるAPMiエンティティの数を指定します。

  • デフォルト: 0

  • 範囲: 0〜500

リリース情報

APMリリース3.0.0で導入されたステートメント。

max-clients APM リリース 3.1.0 で導入されたオプション。