List of M3 Command Line Tools: Difference between revisions

From Alteeve Wiki
Jump to navigation Jump to search
 
(6 intermediate revisions by the same user not shown)
Line 74: Line 74:
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-access-module]]
!style="white-space:nowrap; text-align:left;"|[[anvil-access-module]]
|
|<ToDo>
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-boot-server]]
!style="white-space:nowrap; text-align:left;"|[[anvil-boot-server]]
|
|Tool used to boot servers (virtual machines) on the Anvil! IA cluster.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-change-password]]
!style="white-space:nowrap; text-align:left;"|[[anvil-change-password]]
|
|Tool used to change / reset the main Anvil! password.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-check-memory]]
!style="white-space:nowrap; text-align:left;"|[[anvil-check-memory]]
|
|This reports the total memory used by all processes with to passed-in program name.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-configure-host]]
!style="white-space:nowrap; text-align:left;"|[[anvil-configure-host]]
|
|This program configures the host for use in an Anvil! cluster.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-delete-server]]
!style="white-space:nowrap; text-align:left;"|[[anvil-delete-server]]
|
|This program deletes a server from an Anvil! sub-cluster.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-download-file]]
!style="white-space:nowrap; text-align:left;"|[[anvil-download-file]]
|
|This program downloads a file from a URL
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-file-details]]
!style="white-space:nowrap; text-align:left;"|[[anvil-file-details]]
|
|Display details of the file passed in
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-get-server-screenshot]]
|
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-join-anvil]]
!style="white-space:nowrap; text-align:left;"|[[anvil-join-anvil]]
|
|This tool assembles two subnodes into a node.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-maintenance-mode]]
!style="white-space:nowrap; text-align:left;"|[[anvil-maintenance-mode]]
|
|This program manages flagging a machine in an Anvil! cluster as being in maintenance mode
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-alerts]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-alerts]]
|
|This program manages alerts; Email servers, recipients, alert-override overrides, and generating test alerts.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-daemons]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-daemons]]
|
|Tool used to monitor and manage Anvil! daemons.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-dr]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-dr]]
|
|This program manages if a server is (and when) a server is protected by a DR host.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-files]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-files]]
|
|This program manages the files sync'ed across machines in the Anvil! cluster
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-firewall]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-firewall]]
|
|This program manages the firewall rules on the host.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-host]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-host]]
|
|Tool used to check or set various configuration options for a host.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-keys]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-keys]]
|
|Tool used to manage ssh keys.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-power]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-power]]
|
|This program can power off, reboot, or set a flag indicating one of these actions are required.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-server]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-server]]
|
|Tool used to manage a server, like resync'ing servers on a rebuilt host.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-server-storage]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-server-storage]]
|
|This tool is used to add a disk, grow an existing disk, change the ISO (optical disk) in a virtual optical drive, and change boot devices.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-server-system]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-server-system]]
|
|Tool used to manage the system configuration of a hosted server.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-storage-groups]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-storage-groups]]
|
|This program manages if a server is (and when) a server is protected by a DR host.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-vnc-pipe]]
!style="white-space:nowrap; text-align:left;"|[[anvil-manage-vnc-pipe]]
|
|<ToDo>
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-migrate-server]]
!style="white-space:nowrap; text-align:left;"|[[anvil-migrate-server]]
|
|Tool to migrate servers between subnodes in an Anvil! node.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-network-profiler]]
!style="white-space:nowrap; text-align:left;"|[[anvil-network-profiler]]
|
|Tool to test the network performance between this host and a target host.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-parse-fence-agents]]
!style="white-space:nowrap; text-align:left;"|[[anvil-parse-fence-agents]]
|
|Tool to create a unified XML file with all available fence agent metadata.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-pcs-wrapper]]
!style="white-space:nowrap; text-align:left;"|[[anvil-pcs-wrapper]]
|
|Tools to prevent parallel runs of 'pcs'.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-provision-server]]
!style="white-space:nowrap; text-align:left;"|[[anvil-provision-server]]
|
|Tool to provision new servers.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-rename-server]]
!style="white-space:nowrap; text-align:left;"|[[anvil-rename-server]]
|
|Tool to rename servers.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-report-usage]]
!style="white-space:nowrap; text-align:left;"|[[anvil-report-usage]]
|
|This program reports the current resource usage of servers and the available resources remaining on Anvil! nodes
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-safe-start]]
!style="white-space:nowrap; text-align:left;"|[[anvil-safe-start]]
|
|This program safely joins an Anvil! subnode to a node.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-safe-stop]]
!style="white-space:nowrap; text-align:left;"|[[anvil-safe-stop]]
|
|Tool to show IP addresses, MAC addresses and interface names in use on the system
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-show-local-ips]]
!style="white-space:nowrap; text-align:left;"|[[anvil-show-local-ips]]
|
|Tool to show IP addresses, MAC addresses and interface names in use on the system
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-shutdown-server]]
!style="white-space:nowrap; text-align:left;"|[[anvil-shutdown-server]]
|
|This program shuts down servers hosted on the Anvil! cluster.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-special-operations]]
!style="white-space:nowrap; text-align:left;"|[[anvil-special-operations]]
|
|This program is generally meant to be used by other programs.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-sync-shared]]
!style="white-space:nowrap; text-align:left;"|[[anvil-sync-shared]]
|
|Tool to sync and manage files on the Anvil! cluster.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-update-issue]]
!style="white-space:nowrap; text-align:left;"|[[anvil-update-issue]]
|
|Tool to update /etc/issues with the current IP addresses on the system
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-update-system]]
!style="white-space:nowrap; text-align:left;"|[[anvil-update-system]]
|
|This program updates the local operting system
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-version-changes]]
!style="white-space:nowrap; text-align:left;"|[[anvil-version-changes]]
|
|Tool to do post update changes to the Anvil! cluster
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-virsh-wrapper]]
!style="white-space:nowrap; text-align:left;"|[[anvil-virsh-wrapper]]
|
|Tools to prevent parallel runs of 'virsh'.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-watch-bonds]]
!style="white-space:nowrap; text-align:left;"|[[anvil-watch-bonds]]
|
|Tools to monitor the state of bonded network interfaces
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-watch-drbd]]
!style="white-space:nowrap; text-align:left;"|[[anvil-watch-drbd]]
|
|This program displays the status of DRBD connections in a concise format.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-watch-power]]
!style="white-space:nowrap; text-align:left;"|[[anvil-watch-power]]
|
|Tool used to watch the status of UPSes powering an Anvil! cluster.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[anvil-watch-servers]]
!style="white-space:nowrap; text-align:left;"|[[anvil-watch-servers]]
|
|Tool used to watch the status of servers on an Anvil! node.
|-
|-
|}
|}


= Scan Agents =
= Scan Agents =
scan-apc-pdu
scan-apc-ups
scan-cluster
scan-drbd
scan-filesystems
scan-hardware
scan-hpacucli
scan-ipmitool
scan-lvm
scan-network
scan-server
scan-storcli


{| class="wikitable"
{| class="wikitable"
Line 229: Line 213:
!style="white-space:nowrap; text-align:left;"|Brief Description
!style="white-space:nowrap; text-align:left;"|Brief Description
|-
|-
!style="white-space:nowrap; text-align:left;"|[[]]
!style="white-space:nowrap; text-align:left;"|[[scan-apc-pdu]]
|
|Scancore scan agent for APC-brand switched PDUs.
|-
!style="white-space:nowrap; text-align:left;"|[[scan-apc-ups]]
|Scancore scan agent for APC-brand network connected UPSes.
|-
!style="white-space:nowrap; text-align:left;"|[[scan-cluster]]
|Scancore scan agent for pacemaker cluster status.
|-
!style="white-space:nowrap; text-align:left;"|[[scan-drbd]]
|Scancore scan agent for LINBIT's DRBD resources.
|-
!style="white-space:nowrap; text-align:left;"|[[scan-filesystems]]
|Scancore scan agent for monitoring filesystems.
|-
!style="white-space:nowrap; text-align:left;"|[[scan-hardware]]
|Scancore scan agent for monitoring non-IPMI hardware status.
|-
!style="white-space:nowrap; text-align:left;"|[[scan-hpacucli]]
|Scancore scan agent for HPE brand RAID controllers
|-
!style="white-space:nowrap; text-align:left;"|[[scan-ipmitool]]
|Scancore scan agent for IPMI BMC sensor data.
|-
!style="white-space:nowrap; text-align:left;"|[[scan-lvm]]
|Scancore scan agent for logival volume management.
|-
!style="white-space:nowrap; text-align:left;"|[[scan-network]]
|Scancore scan agent for network interface states.
|-
!style="white-space:nowrap; text-align:left;"|[[scan-server]]
|Scancore scan agent for KVM/qemu virtual server states.
|-
!style="white-space:nowrap; text-align:left;"|[[scan-storcli]]
|Scancore scan agent for LSI based RAID controllers, including Dell 'PERC' RAID controllers.
|-
|-
|}
|}
Line 237: Line 254:


These tools are designed for use primarily by other tools, and are not meant to be used by administrators directly.
These tools are designed for use primarily by other tools, and are not meant to be used by administrators directly.
fence_pacemaker
generate_pm_dispatch_table
scancore
unfence_pacemaker


{| class="wikitable"
{| class="wikitable"
Line 265: Line 277:
|This is a [[DRBD]] fence agent. It acts as a glue layer so that DRBD can request a resource (or node) be fenced, and passing that request on to Pacemaker.
|This is a [[DRBD]] fence agent. It acts as a glue layer so that DRBD can request a resource (or node) be fenced, and passing that request on to Pacemaker.
|-
|-
!style="white-space:nowrap; text-align:left;"|[[scancore]]
!style="white-space:nowrap; text-align:left;"|[[scancore (man page)|scancore]]
|This is the [[Scancore]] daemon, which is the component of the Anvil! cluster that provides all of the Intelligent Availability / risk mitigation.
|This is the [[Scancore]] daemon, which is the component of the Anvil! cluster that provides all of the Intelligent Availability / risk mitigation.
|-
|-

Latest revision as of 20:14, 22 August 2024

 Alteeve Wiki :: How To :: List of M3 Command Line Tools

The Anvil! uses a fairly naming convention. That is;

  • Tools that start with striker-X are tools useful mainly to Striker dasboards.
  • Tools that start with anvil-X are tools that can be useful on any machine in the Anvil! cluster

Separately, Scancore has a collection of scan agents, programs designed to collect information on hardware, software or other sources of information that can prove useful to the Scancore decision engine. These agents are core to the Anvil! system's Intelligent Availability capabilities.

Striker-Specific Tools

Command Brief Description
striker-auto-initialize-all Tools to autonomously configure all machines in an Anvil! IA cluster
striker-boot-machine Tool used to boot physical machines that have IPMI configuration information.
striker-check-machines This program tests access and, when not reachable, checks the power state if out of band management is available.
striker-collect-debug This program collects data needed to help diagnose problems with an Anvil! system.
striker-db-status This shows the current status of striker dashboards
striker-file-manager This manages the files available for use by servers
striker-get-peer-data This manages peering two Striker dashboards
striker-get-screenshots Tool used to collect screenshots from Anvil! subnodes and DR hosts
striker-initialize-host Tool used on Striker dashboards to initialize new Nodes and DR hosts.
striker-manage-install-target This manages the "Install Target" feature on Striker dashboards
striker-manage-peers This manages peering two Striker dashboards
striker-parse-oui This parses the IEEE OUI file and parses it for storage in the Anvil database
striker-purge-target This tool purges the target from all Anvil! databases.
striker-scan-network This scans accessible networks to create a map of MAC addresses to IP addresses
striker-show-db-counts This shows the number of records in accessible databases.
striker-show-jobs This shows the queued, running and (recently) completed jobs.
striker-update-cluster This program updates all physical machines in an Anvil! cluster

General Tools

Command Brief Description
anvil-access-module <ToDo>
anvil-boot-server Tool used to boot servers (virtual machines) on the Anvil! IA cluster.
anvil-change-password Tool used to change / reset the main Anvil! password.
anvil-check-memory This reports the total memory used by all processes with to passed-in program name.
anvil-configure-host This program configures the host for use in an Anvil! cluster.
anvil-delete-server This program deletes a server from an Anvil! sub-cluster.
anvil-download-file This program downloads a file from a URL
anvil-file-details Display details of the file passed in
anvil-join-anvil This tool assembles two subnodes into a node.
anvil-maintenance-mode This program manages flagging a machine in an Anvil! cluster as being in maintenance mode
anvil-manage-alerts This program manages alerts; Email servers, recipients, alert-override overrides, and generating test alerts.
anvil-manage-daemons Tool used to monitor and manage Anvil! daemons.
anvil-manage-dr This program manages if a server is (and when) a server is protected by a DR host.
anvil-manage-files This program manages the files sync'ed across machines in the Anvil! cluster
anvil-manage-firewall This program manages the firewall rules on the host.
anvil-manage-host Tool used to check or set various configuration options for a host.
anvil-manage-keys Tool used to manage ssh keys.
anvil-manage-power This program can power off, reboot, or set a flag indicating one of these actions are required.
anvil-manage-server Tool used to manage a server, like resync'ing servers on a rebuilt host.
anvil-manage-server-storage This tool is used to add a disk, grow an existing disk, change the ISO (optical disk) in a virtual optical drive, and change boot devices.
anvil-manage-server-system Tool used to manage the system configuration of a hosted server.
anvil-manage-storage-groups This program manages if a server is (and when) a server is protected by a DR host.
anvil-manage-vnc-pipe <ToDo>
anvil-migrate-server Tool to migrate servers between subnodes in an Anvil! node.
anvil-network-profiler Tool to test the network performance between this host and a target host.
anvil-parse-fence-agents Tool to create a unified XML file with all available fence agent metadata.
anvil-pcs-wrapper Tools to prevent parallel runs of 'pcs'.
anvil-provision-server Tool to provision new servers.
anvil-rename-server Tool to rename servers.
anvil-report-usage This program reports the current resource usage of servers and the available resources remaining on Anvil! nodes
anvil-safe-start This program safely joins an Anvil! subnode to a node.
anvil-safe-stop Tool to show IP addresses, MAC addresses and interface names in use on the system
anvil-show-local-ips Tool to show IP addresses, MAC addresses and interface names in use on the system
anvil-shutdown-server This program shuts down servers hosted on the Anvil! cluster.
anvil-special-operations This program is generally meant to be used by other programs.
anvil-sync-shared Tool to sync and manage files on the Anvil! cluster.
anvil-update-issue Tool to update /etc/issues with the current IP addresses on the system
anvil-update-system This program updates the local operting system
anvil-version-changes Tool to do post update changes to the Anvil! cluster
anvil-virsh-wrapper Tools to prevent parallel runs of 'virsh'.
anvil-watch-bonds Tools to monitor the state of bonded network interfaces
anvil-watch-drbd This program displays the status of DRBD connections in a concise format.
anvil-watch-power Tool used to watch the status of UPSes powering an Anvil! cluster.
anvil-watch-servers Tool used to watch the status of servers on an Anvil! node.

Scan Agents

Command Brief Description
scan-apc-pdu Scancore scan agent for APC-brand switched PDUs.
scan-apc-ups Scancore scan agent for APC-brand network connected UPSes.
scan-cluster Scancore scan agent for pacemaker cluster status.
scan-drbd Scancore scan agent for LINBIT's DRBD resources.
scan-filesystems Scancore scan agent for monitoring filesystems.
scan-hardware Scancore scan agent for monitoring non-IPMI hardware status.
scan-hpacucli Scancore scan agent for HPE brand RAID controllers
scan-ipmitool Scancore scan agent for IPMI BMC sensor data.
scan-lvm Scancore scan agent for logival volume management.
scan-network Scancore scan agent for network interface states.
scan-server Scancore scan agent for KVM/qemu virtual server states.
scan-storcli Scancore scan agent for LSI based RAID controllers, including Dell 'PERC' RAID controllers.

Specialized Tools

These tools are designed for use primarily by other tools, and are not meant to be used by administrators directly.

Command Brief Description
anvil-daemon This is the main Anvil! daemon. It maintains the state of the various machines in the cluster, runs jobs as needed, etc.
anvil-monitor-network This is a daemon that watches for changes to network interfaces. When changes are detected, the 'scan-network' scan agent is called. This ensures that changes are quickly reflected in the Anvil! database, which is particularly useful when mapping network interfaces.
anvil-monitor-performance This is a daemon that collects performance data and records it in the anvil.log log file. This is designed to help diagnose performance issues by keeping track of CPU load, I/O wait times, and other metrics.
alteeve-repo-setup This tool configures the Alteeve repository. Primarily it is used to setup the repository needed to access Alteeve software, and to switch between the community and enterprise repositories.
fence_delay This is a pseudo fence agent that the Anvil! uses automatically when a subnode has an IPMI BMC. It's purpose is the slow down Pacemaker to give time for the IPMI BMC to boot after a power fence device, like a switched PDU, cut and restored power to a failed node.
fence_pacemaker This is a DRBD fence agent. It acts as a glue layer so that DRBD can request a resource (or node) be fenced, and passing that request on to Pacemaker.
scancore This is the Scancore daemon, which is the component of the Anvil! cluster that provides all of the Intelligent Availability / risk mitigation.
unfence_pacemaker This is the DRBD "unfence" agent. It acts as a glue layer so that DRBD can request a resource be unfenced, and passing that request on to Pacemaker.

 

Any questions, feedback, advice, complaints or meanderings are welcome.
Alteeve's Niche! Enterprise Support:
Alteeve Support
Community Support
© Alteeve's Niche! Inc. 1997-2024   Anvil! "Intelligent Availability®" Platform
legal stuff: All info is provided "As-Is". Do not use anything here unless you are willing and able to take responsibility for your own actions.