1. コマンドライン・インタフェース
  2. Verbリファレンス
  3. EM CLI Verb
  4. create_blackout

create_blackout

1つ以上のモニター対象ターゲットでデータ収集アクティビティを保留するスケジュールされたブラックアウトを作成します。

書式

emcli create_blackout
      -name="name"
      -add_targets="name1:type1;name2:type2;..."...
      -reason="reason"
      [-description="description"]
      [-notification_only]
      [-is_sla_required]
      [-jobs_allowed] 
      [-propagate_targets]
      [-full_blackout_all_hosts]
      [-dep_services_all]
      [-exclude_types]
      [-exclude_target]
      -schedule=
         [frequency:once|interval|weekly|monthly|yearly];
         duration:[HH...][:mm...];
         [start_time:yy-MM-dd HH:mm];
         [end_time:yy-MM-dd HH:mm];
         [repeat:#m|#h|#d|#w];
         [months:#,#,...];
         [days:#,#,...];
         [tzinfo:specified|target|repository]
         [tzoffset:#|[-][HH][:mm]]
         [tzregion:...]

[ ]  indicates that the parameter is optional

スケジュール引数の制限:

frequency:once
    requires => duration or end_time
    optional => start_time, tzinfo, tzoffset
frequency:interval
    requires => duration, repeat
    optional => start_time, end_time, tzinfo, tzoffset
frequency:weekly
    requires => duration, days
    optional => start_time, end_time, tzinfo, tzoffset
frequency:monthly
    requires => duration, days
    optional => start_time, end_time, tzinfo, tzoffset
frequency:yearly
    requires => duration, days, months
    optional => start_time, end_time, tzinfo, tzoffset

オプション

  • name

    作成するブラックアウトの名前。

  • add_targets

    ブラックアウトに追加するターゲット。それぞれをtarget_name:target_typeとして指定します。このオプションは、複数回指定できます。

  • reason

    ブラックアウトの理由。SUPER_USER権限がある場合(Enterprise Managerのスーパー管理者)、理由には任意のテキスト文字列を使用できます。理由がリストにない場合、許容可能なブラックアウト理由のリストに追加されます。SUPER_USER権限がない場合、get_blackout_reasons Verbから返されるテキスト文字列の1つを指定する必要があります。

  • description

    ブラックアウトに関連する説明またはコメント。説明は2000文字以内で、任意のテキスト文字列を使用できます。

  • notification_only

    このオプションを指定すると、デフォルトで、選択したターゲットに計画メンテナンスの通知ブラックアウトが作成されます。ブラックアウト期間は、可用性(%)の計算から除外されます。

  • is_sla_required

    このオプションを指定すると、計画外メンテナンスの通知ブラックアウトが作成されます。ブラックアウト期間は、可用性(%)の計算で考慮されます。

  • jobs_allowed

    このオプションを指定すると、ブラックアウト期間中もブラックアウトされたターゲットに対してジョブを実行できます。このオプションを指定しない場合、これらのターゲットに対して実行される予定のジョブは、ブラックアウト期間中実行できません。ブラックアウトを作成すると、EMCLIまたはEnterprise Manager Cloud Controlコンソールからジョブの許可を変更できません。

  • propagate_targets

    このオプションを指定すると、タイプがホストであるターゲットに対するブラックアウトは、エージェントを含むそのホスト上のすべてのターゲットに対して適用されます。これは、emctlコマンドのnodelevelに相当します。このオプションが指定されているかどうかに関係なく、コンポジットまたはグループのターゲットに対するブラックアウトは、コンポジットまたはグループのすべてのメンバーに適用されます。

  • full_blackout_all_hosts

    このオプションを指定すると、このブラックアウトに含まれるすべてのホストで完全なブラックアウトが有効になります。完全なブラックアウトにより、ホストおよびホスト上のすべてのターゲット(エージェントを含む)がブラックアウトされます。propagate_targetsオプションは、このオプションの選択時に暗黙的に有効になります。

  • dep_services_all

    このオプションを指定すると、ブラックアウトに選択したターゲットのすべての依存ターゲットもブラックアウトされます。

  • exclude_types

    ターゲット・タイプのリストが指定できます。そのタイプの間接メンバーとそのメンバーはブラックアウトの一部にはなりません。たとえば、oracle_dbsysを指定すると、指定しなければブラックアウトの間接メンバーになるデータベース・システムおよびそのメンバーは除外されます。フラグexclude_targetsとexclude_typesは、互いに組み合せて使用できます。

  • exclude_target

    ブラックアウトから除外する間接メンバー・ターゲットのリストを指定できます。ブラックアウトの間接メンバーとそのメンバーはブラックアウトの一部にはなりません。たとえば、データベース・システム・ターゲットを指定すると、指定しなければブラックアウトの間接メンバーになるターゲットとそれに対応するデータベース・インスタンスがブラックアウトから除外されます。フラグexclude_targetsとexclude_typesは、互いに組み合せて使用できます。

  • schedule

    ブラックアウト・スケジュール。frequency引数によって、他の引数が必須かオプションかが決まります。

  • schedule=frequency

    ブラックアウト・スケジュールのタイプ(デフォルトはonce)。

  • schedule=duration

    ブラックアウトの期間を時間と分で指定します(-1は無限)。時間と分はそれぞれ6桁まで指定できます。

  • schedule=start_time

    ブラックアウトの開始日と時間。デフォルト値は現在の日付と時間です。値の書式は"yy-MM-dd HH:mm"です。たとえば: "2003-09-25 18:34"

  • schedule=end_time

    ブラックアウトの最終日と時間。frequencyが、weekly、monthlyまたはyearlyの場合、日付部分のみを使用します。frequencyがintervalまたはonceの場合、日付と時間が考慮されます。値の書式は"yy-MM-dd HH:mm"です。たとえば: "2003-09-25 18:34"

  • schedule=repeat

    ブラックアウトの開始時間から次の開始時間までの時間。数値の後ろの文字は時間の単位を表し、mは分、hは時間、dは日、wは週を表します。

  • schedule=months

    1から12までの整数で表される月の値のリスト。その年のブラックアウト開始日を月と日で完全に指定するには、各値に対応するday値が必要です。

  • schedule=days

    frequencyがweeklyの場合、1から7(1が日曜日)の整数で表される曜日の値のリストです。frequencyがmonthlyの場合、1から31または-1(月の最終日)の整数で表される日の値のリストです。frequencyがyearlyの場合、1から31または-1(月の最終日)の整数で表される日の値のリストです。この場合、月は、月と日の各ペアの対応する月の値になります。

  • schedule=tzinfo

    タイムゾーンのタイプ。tzinfo引数は、tzoffsetと組み合せて使用されます。使用可能なタイムゾーン・タイプは、specified(GMTとターゲット・タイムゾーンの間のオフセット)、target(指定されたターゲットのタイムゾーン)、およびrepository(リポジトリのタイムゾーン。tzinfoが指定されていない場合のデフォルト設定)です。詳細は、-schedule=tzoffsetを参照してください。

  • schedule=tzoffset

    タイムゾーンの値。tzinfo引数が指定されていないかrepositoryの場合、タイムゾーン値はリポジトリのタイムゾーンになります。この場合、tzoffset引数を指定することはできません。それ以外の場合は、tzoffset引数が必要です。tzinfoがspecifiedに設定されている場合、tzoffset引数では、GMTとタイムゾーン間のオフセットを時間と分で指定します。tzinfoがtargetに設定されている場合、tzoffset引数では、引数として渡されるターゲットのリストに整数のインデックス(最初は1)を指定します。たとえば、tzoffsetが1の場合、-add_targetsオプションで指定された最初のターゲットのタイムゾーンが使用されます。

    タイムゾーンは、ブラックアウト期間の開始時間と終了時間に適用されます。ブラックアウト期間のスケジュールを設定する際、各ターゲットに関連付けられているタイムゾーンは考慮されません(ただし、tzinfoがtargetに設定されている場合は、指定されたターゲットのタイムゾーンがブラックアウト時間に使用されます)。

  • schedule=[tzregion:<...>]

    使用するタイムゾーン・リージョン。tzinfoオプションを指定した場合、このオプションはブラックアウト・スケジュールに使用するタイムゾーンを決定します。それ以外の場合、このパラメータは無視されます。デフォルトはGMTです。

例

例1

この例では、指定したターゲット(database2)に、即座に開始し、30分間続くブラックアウトb1を作成します。 

emcli create_blackout
      -name=b1
      -add_targets=database2:oracle_database
      -schedule="duration::30"
      -reason="good reason1"

例2

この例では、指定したターゲット(database2およびdatabase3)に、2007-08-24 22:30に開始され30分間続くブラックアウトb1を作成します。タイムゾーンは、database2ターゲットのタイムゾーンです。 

emcli create_blackout
      -name=b1
      -add_targets="database2:oracle_database;database3:oracle_database
      -schedule="frequency:once;start_time:07-08-24 22:30;duration::30;tzinfo:target:tzoffset:1"
      -reason="good reason4"

例3

次の例では、WebLogicドメインにブラックアウトを作成しますが、データベース・システムとそのメンバー・ターゲットは除外します

emcli create_blackout 
      -name="wlblkout" 
      -add_targets="weblogic:weblogic_domain" 
      -exclude_types="oracle_dbsys"
      -schedule="duration::30"
      -reason="good reason1"

例4

次の例では、数百のWebLogicドメインを含むグループにブラックアウトを作成します。ブラックアウトには、データベース・システムおよびそのメンバー・ターゲット(Oracleホーム、リスナー、データベース・インスタンスなど)は含まれません。

emcli create_blackout
      -name=Group_Blackout
      -add_targets="Weblogic_Domain_Group:group"
      -exclude_types=oracle_dbsys
      -schedule="duration:1:30"
      -reason="WebLogic Domain Maintenance"