vCenter に定義されているアラーム定義のダンプを取得する方法

 

アラーム定義情報を一括で取得したい！

 

VxRailのログを見ていると、ときどき突如としてalarm-xx が現れることがあります。

 

 

alam-xxはvCenterで定義されている個々のアラームに対応するMoref IDなので、当然ながらそれに対応するアラーム定義があるのですが、残念ながらMoref IDは環境によって異なりますし、（あるかもしれませんが）ID採番のRuleなどもなさそうなのでMorefIDだけからアラームの詳細を予測することができません。

 

 

 

そのため、何かが起きていることはわかるのですが、「何が起きているの！！？？」とちょっとドキドキしてしまいます。

そういう時、「全部のAlarmのMorefIDと対応する情報が一括で取得できたらいいのに・・・」と常々思っていました。

 

 

 

また、運用管理者の観点からも現在のシステムに定義されているアラームの一覧やダンプを取得したい！ということはあるかと思います。

 

 

しかしながら、WebClientや標準のコマンドとしてアラーム定義の細かい情報を一括でExportしたりする方法は見当たりませんでした。

アラーム名と定義場所は出せるかも知れませんが細かいトリガーやアクションの情報となるとWebClientから一つ一つコピー＆ペーストするような作業になってしまうのでとてもやる気になりません。

 

 

ということで、今回はvSphere SDK for pythonを利用して、VCSA CLI上で一括でアラーム定義情報をDumpスクリプトを作成しましたので、使用方法と合わせて共有させていただきます。

 

 

開発・検証環境

 

今回のスクリプトは以下の環境で動作検証をしました。

多少Versionが違っても動くとは思います。

もし動かなかったらコメント等で教えていただければ、時間があるときに修正します。

もちろんご自由にスクリプトを書き換えていただいてもかまいません。

 

VxRail™ Appliance 4.5.229

VMware vCenter Server Virtual Appliance (vCSA) 6.5 U2c GA build 9451637

VMware ESXi 6.5 Express Patch 11 GA build 10719125

 

 

 

使用方法

 

いざ、スクリプトファイルと添付して使用方法を書くぞ！、、、と思った段階で初めて気づきましたが、このブログはファイルの添付ができないんですね。。。仕方ないのでソースを直に書きます。

HTMLによる不必要な改行の挿入などによるコード破壊を防ぐため、あえてフォーマットを無効にしています。

少し見栄えが悪いですがご容赦ください。

pythonは文法上、改行やインデントにシビアなのでコピペする際にご留意ください。不必要な空行や、スペースが一つ挿入されただけでも動かなくなります。

 

#####   ここから ######   

# coding:utf-8
#!/usr/bin/env python

from __future__ import print_function
from __future__ import unicode_literals
import os
import codecs
import subprocess
import re
import string
import json
import ssl
import sys
import traceback
import atexit
import platform
import time
import datetime
import socket
import getpass
import argparse

sys.path.append("/usr/lib/vmware/site-packages/")

from pyVmomi import vim, vmodl
from pyVim import connect
from pyVim.connect import SmartConnect, Disconnect
from pyVim.task import WaitForTask


def parse_argument():
    parser = argparse.ArgumentParser(description='Print All Alarm Definition')
    parser.add_argument('-s', '--server', dest="server", required=True, help='vCenter IP Address')
    parser.add_argument('-u', '--username', dest="username", required=True, help='vCenter SSO admin username')
    parser.add_argument('-p', '--password', dest="password", required=True, help='vCenter SSO admin password')
    args = parser.parse_args()
    return args



def main():
    args = parse_argument()
    vcipaddr = args.server
    vcusername = args.username
    vcpassword = args.password
    context = None
    context = ssl.create_default_context()
    context.check_hostname = False
    context.verify_mode = ssl.CERT_NONE
    si = connect.Connect(host = vcipaddr,user = vcusername,pwd = vcpassword)
    atexit.register(Disconnect, si)
    
    alarms = si.content.rootFolder.declaredAlarmState
    for alarm in alarms:
        print(alarm.alarm.info)

if __name__ == '__main__':
    main()

#####  ここまで  ####### 

 

 

↑上記の内容をVCSAの適当な場所にdump_AlarmDefinition.pyとして保存してください。

 

保存したら以下のSyntaxで実行してみてください。

 

root@vc [ ~ ]# python dump_AlarmDefinition.py -s <vcenter ip> -u <vcenter sso user> -p '<vcenter sso user password>'

 

パスワードに特殊文字が含まれる場合は、シングルクォーテーションで括ってください。

例は以下です。

※例にあるパスワードはVMware HOLで用いられるものを仮で使用しており、その他の意味はありません。

 

実行例：

root@vc [ ~ ]# python dump_AlarmDefinition.py -s localhost -u administrator@vsphere.local -p 'VMware1!'

 

 

サンプル出力：

root@vc [ ~ ]# python dump_AlarmDefinition.py -s localhost -u administrator@vsphere.local -p 'VMware1!'
(vim.alarm.AlarmInfo) {
   dynamicType = <unset>,
   dynamicProperty = (vmodl.DynamicProperty) [],
   name = 'Host Requires Encryption Mode Enabled Alarm',
   systemName = 'alarm.HostRequiresEncryptionModeEnabledAlarm',
   description = 'Alarm to indicate that the host requires encryption mode enabled.',
   enabled = true,
   expression = (vim.alarm.OrAlarmExpression) {
      dynamicType = <unset>,
      dynamicProperty = (vmodl.DynamicProperty) [],
      expression = (vim.alarm.AlarmExpression) [
         (vim.alarm.EventAlarmExpression) {
            dynamicType = <unset>,
            dynamicProperty = (vmodl.DynamicProperty) [],
            comparisons = (vim.alarm.EventAlarmExpression.Comparison) [],
            eventType = vim.event.EventEx,
            eventTypeId = 'com.vmware.vc.host.Crypto.ReqEnable.KeyMissingOnKMS',
            objectType = vim.HostSystem,
            status = 'red'
         },
         (vim.alarm.EventAlarmExpression) {
            dynamicType = <unset>,
            dynamicProperty = (vmodl.DynamicProperty) [],
            comparisons = (vim.alarm.EventAlarmExpression.Comparison) [],
            eventType = vim.event.EventEx,
            eventTypeId = 'com.vmware.vc.host.Crypto.ReqEnable.KMSClusterError',
            objectType = vim.HostSystem,
            status = 'red'
         },
         (vim.alarm.EventAlarmExpression) {
            dynamicType = <unset>,
            dynamicProperty = (vmodl.DynamicProperty) [],
            comparisons = (vim.alarm.EventAlarmExpression.Comparison) [],
            eventType = vim.event.EventEx,
            eventTypeId = 'com.vmware.vc.crypto.HostKeyUpdatedEvent',
            objectType = vim.HostSystem,
            status = 'green'
         },
         (vim.alarm.EventAlarmExpression) {
            dynamicType = <unset>,
            dynamicProperty = (vmodl.DynamicProperty) [],
            comparisons = (vim.alarm.EventAlarmExpression.Comparison) [],
            eventType = vim.event.EventEx,
            eventTypeId = 'com.vmware.vc.host.Crypto.Enabled',
            objectType = vim.HostSystem,
            status = 'green'
         }
      ]
   },
   action = <unset>,
   actionFrequency = 0,
   setting = (vim.alarm.AlarmSetting) {
      dynamicType = <unset>,
      dynamicProperty = (vmodl.DynamicProperty) [],
      toleranceRange = 0,
      reportingFrequency = 300
   },
   alarmMetadata = <unset>,
   key = 'alarm-1',
   alarm = 'vim.alarm.Alarm:alarm-1',
   entity = 'vim.Folder:group-d1',
   lastModifiedTime = 2018-12-01T17:27:21.718Z,
   lastModifiedUser = '',
   creationEventId = 0
}
 
........... 以降、全アラーム情報がDumpされる

 

 

問題なく情報をダンプすることができました。

出力がかなり長くなりますのでリダイレクトなどしてファイルにいったんファイルに出力するのがお勧めです。

アラーム定義のオブジェクト情報がそのまま表示されているので見にくいですが、アラーム定義の情報をすべて網羅しているのでテキスト処理などで必要な部分のみを抽出したりできますし、またソースを変更して、名前とトリガーとアクション情報のみを抽出することも可能です。

 

例えばスクリプト中の

 

print(alarm.alarm.info)

 

の部分を

 

print(alarm.alarm.info.name)

print(alarm.alarm.info.expression)

print(alarm.alarm.info.action)

 

とすれば、アラーム定義の名前とトリガー＆アクション部分のみを抽出できます。

※pythonなのでインデントや改行には注意してください。↑はHTMLのフォーマットを無効にしていません

 

 

いかがでしたでしょうか？実際に業務で使える情報抽出まではあと一段階の処理が必要となるとおもいますが、

テキスト処理やpythonであればいくらでも有識者はいますので、このDump情報があれば環境に合わせて自由に必要な情報を抽出・成形できると思います。

 

この記事の内容がお役に立てれば幸いです。

コメント

コメントを投稿

このブログの人気の投稿

vSwitchにSTPが不要な理由

イメージ
  ** 知っている人にとっては当たり前の内容です**     ESXiは多くの場合、冗長構成をとるために二つ以上のNICを利用し、それぞれ単一、もしくは別個の物理スイッチに接続されていると思います。 ESXiの物理NICはuplinkまたはvmnicとよばれ、ESXi内部にある仮想スイッチ（vSwitch）につながっています。 vSwitchはL2SWとしての役割をするため、物理スイッチをESXiの接続はスイッチ間接続となります。   図１：ネットワークトポロジ     vSwitchが物理スイッチと同等の動作をすると仮定した場合、この構成はループに相当します。 L2レベルでループがある場合は、ブロードキャストストームなどの問題が発生するためにSpanning Tree Protocol（STP）を設定する必要（最近では必ずしもそうとは言い切れないようですが。。。）があります。   ではvSwitchの場合でもSpanning Treeに参加する（ネットワークは専門外なので表現が間違っていたらすみません。。。）必要があるのでしょうか？ 表題からもわかるように答えはNoです。 L2ネットワークでBPDUと呼ばれるパケットをやり取りすることで Spanning Treeが構成されますが、実際に、vSwitchではこのBPDUをDropしますので、vSwitchのUplinkがBlockされることはありません。   ではなぜ、vSwitchではトポロジ的にLoopであるにもかかわらずSpanning Treeが不要なのでしょうか？Loopによる問題は発生しないのでしょうか？   実はvSwitchはFloodingが必要な通信に対して特殊な動作をします。 その特殊動作のため、トポロジ的にLoopであっても問題は発生せず、Spanning Treeに参加する必要がないのです。   たとえば、ARPなどの外部からのブロードキャストフレームをuplink経由でvSwitchが受け取った場合、vSwitchに接続されるVMに対してはフレームを転送しますが、ほかのUplinkに対してはフレームを転送しません。   下図ではUplink1からBroadcast Packetを受信した際の動作を示しています。 Broadcast Packetは仮想スイッチに接続されるVMに対して転送
続きを読む

ESXi に DNS サーバを何個まで登録できるか

イメージ
ESXi の DNS サーバの最大登録可能数を調べる vSphere 構築経験のある多くの方は2つまでとお答えになるかもしれない。 なぜならば、DCUI や vSphere Client から設定した場合、Primary DNS と Alternative DNS の2つまでしか設定できないからだ。 GUI から設定する場合、苦し紛れにカンマ区切りなどで3つ以上登録しようと試みても無駄である。GUI でエラーになってはじかれるだけだ。 ならば、CLI はどうか。 /etc/resolv.conf に手動で追記していくだけであればストレージの許す限り記載することはできるだろうが、 この方法は当然ながら標準的な手順ではない。 esxcli を利用して DNS を登録することも可能である。具体的には以下のコマンドを利用する esxcli network ip dns server add -s <ip_address> 上記のコマンドを利用してどこまで登録可能かを試してみた。 具体的には以下のコマンドを用いて255個のDNSサーバを追加してみた for i in `seq 1 255`; do esxcli network ip dns server add -s 192.0.2.$i ;done なお、本ブログで記載される IP Address は例示用に予約されたものであり、RFC5737 から拝借している。 結果として、少々時間はかかるが登録自体は問題なく成功した。 実環境においてこれほど多くの DNS の登録をすることはあり得ないので、事実上制限なしと考えられる。 なお、参考のために他ベンダーも含める形で DNS 登録数の最大数を調べたところ、2 か 3 にしているところが多いようだ。 DNS を大量に登録した際の動作を調べる DNS クエリのタイムアウト時間：5 秒則 ESXi の DNS Client は最近の systemd-resolved などではなく、レガシーなソフトウェアであるため、 resolv.conf の上から順番に問い合わせていき、問合せ先の DNS に到達できなかった場合に次の DNS サーバに問い合わせる動作になる。 次の DNS サーバに問い合わせる条件はあくまでも到達できなかった場合であり、到達できた
続きを読む

障害でVDSから切断されたVCSAの復旧方法

この投稿は vExpert Advent Calendarの10日目です。 https://adventar.org/calendars/6689 本記事では以下の状況と、簡易な復旧方法について説明します。 環境 vCSAは自身が管理するvSphere Cluster上に存在する。 vCSAは自身が管理する vDSに接続される vCSAが接続されるdvportgroupはEphemeralではない 該当のvCSA以外にvSphere Clusterを管理できる vCSA は存在しない  障害状況 vCSAは何らかの理由により、もともと存在していたESXiから、別のESXiに再登録されている。 vCSAはvDSから切断されてしまっている。 解説 上記の状況は、ESXiの障害などによって副次的に発生しうる状況です。もともと、vCSA は vDS に接続されていましたが、ESXi の障害などにより、いったん Guest OS から Shutdown され、Host Client を利用して別の ESXi に再登録したうえで起動しています。 この場合、もともとvCSAが接続されていたdvportは別の ESXi 上のポートであるため、起動時にvCSAはvNICを接続することができず、切断状態となります。 vCSAが切断状態になり、かつESXiのHost Clientからは仮想マシンをvDSに接続することができないため（Ephemeral Port を除く）、vCSAの復旧が困難となります。  この状況において有効な解決策としては事前に用意しておいたEphemeral Port を利用するか、もしくは一時的にVSSを作成して復旧する方法が一般的な方法です。 事前にEphemeral Port の準備がない場合には、VSSを作成することになりますが、Uplinkに空きがない場合は、Uplinkを付け替える必要があり、手順は複雑になります。 今回はVSSを利用しない簡易な復旧方法についてご紹介します。 簡易な復旧方法 完結に手順を示すと以下です。 vNICが切断されているVCSAをShutdown  vCSAが存在する ESXi を Maintenance Mode～Reboot  vCSA を再度起動～vNICが接続状態であることを確認  上記に示した通り、ESXiをリブート
続きを読む