bionic (8) fence_azure_arm.8.gz

NAME

       fence_azure_arm - Fence agent for Azure Resource Manager

DESCRIPTION

       Used to deallocate virtual machines and to report power state of virtual machines running in Azure

       fence_azure_arm  accepts  options  on  the  command  line  as well as from stdin. Fenced sends parameters
       through stdin when it execs the agent. fence_azure_arm can be run by itself with  command  line  options.
       This is useful for testing and for turning outlets on or off from scripts.

       Vendor URL: http://www.microsoft.com

PARAMETERS

       -o, --action=[action]
              Fencing action (Default Value: reboot)

       -p, --password=[password]
              Login password or passphrase

       -S, --password-script=[script]
              Script to run to retrieve password

       -n, --plug=[id]
              Physical  plug  number  on  device,  UUID  or  identification  of machine This parameter is always
              required.

       -l, --username=[name]
              Login name This parameter is always required.

       --resourceGroup=[name]
              Name of resource group. This parameter is always required.

       --tenantId=[name]
              Id of Azure Active Directory tenant. This parameter is always required.

       --subscriptionId=[name]
              Id of the Azure subscription. This parameter is always required.

       -q, --quiet
              Disable logging to stderr. Does not affect --verbose or --debug logging to syslog.

       -v, --verbose
              Verbose mode

       -D, --debug-file=[debugfile]
              Write debug information to given file

       -V, --version
              Display version information and exit

       -h, --help
              Display help and exit

       -C, --separator=[char]
              Separator for CSV created by 'list' operation (Default Value: ,)

       --delay=[seconds]
              Wait X seconds before fencing is started (Default Value: 0)

       --login-timeout=[seconds]
              Wait X seconds for cmd prompt after login (Default Value: 5)

       --power-timeout=[seconds]
              Test X seconds for status change after ON/OFF (Default Value: 20)

       --power-wait=[seconds]
              Wait X seconds after issuing ON/OFF (Default Value: 0)

       --shell-timeout=[seconds]
              Wait X seconds for cmd prompt after issuing command (Default Value: 3)

       --retry-on=[attempts]
              Count of attempts to retry power on (Default Value: 1)

ACTIONS

       on     Power on machine.

       off    Power off machine.

       reboot Reboot machine.

       status This returns the status of the plug/virtual machine.

       list   List available plugs with aliases/virtual machines if there is support for more then  one  device.
              Returns N/A otherwise.

       list-status
              List  available  plugs  with  aliases/virtual machines and their power state if it can be obtained
              without additional commands.

       monitor
              Check the health of fence device

       metadata
              Display the XML metadata describing this resource.

       validate-all
              Validate if all required parameters are entered.

STDIN PARAMETERS

       action Fencing action (Default Value: reboot)

       password
              Login password or passphrase Obsoletes: passwd

       password_script
              Script to run to retrieve password Obsoletes: passwd_script

       plug   Physical plug number on device, UUID  or  identification  of  machine  This  parameter  is  always
              required. Obsoletes: port

       username
              Login name This parameter is always required. Obsoletes: login

       resourceGroup
              Name of resource group. This parameter is always required.

       tenantId
              Id of Azure Active Directory tenant. This parameter is always required.

       subscriptionId
              Id of the Azure subscription. This parameter is always required.

       quiet  Disable logging to stderr. Does not affect --verbose or --debug logging to syslog.

       verbose
              Verbose mode

       debug_file
              Write debug information to given file Obsoletes: debug

       version
              Display version information and exit

       help   Display help and exit

       separator
              Separator for CSV created by 'list' operation (Default Value: ,)

       delay  Wait X seconds before fencing is started (Default Value: 0)

       login_timeout
              Wait X seconds for cmd prompt after login (Default Value: 5)

       power_timeout
              Test X seconds for status change after ON/OFF (Default Value: 20)

       power_wait
              Wait X seconds after issuing ON/OFF (Default Value: 0)

       shell_timeout
              Wait X seconds for cmd prompt after issuing command (Default Value: 3)

       retry_on
              Count of attempts to retry power on (Default Value: 1)