All Hosts

The hosts page (also known as the all hosts page) can be accessed via The Hosts Menu:

Hosts > All hosts

Hosts are arguably the most basic type of entity managed through orcharhino, and doing so is orcharhino’s main purpose. As a result the hosts page (reached through the All hosts menu entry) along with related pages take on a central role in orcharhino usage. orcharhino’s all hosts list includes both bare metal deploys and virtual machines.

Note

The all hosts list is context-sensitive. (See also: The Context Menu). This means only those hosts associated with the currently selected context (<organization>@<location>) will be visible in the list. Select Any Organization and Any Location from the context menu to see all existing hosts.


The hosts page includes an Export button, a Select Action menu, a Create Host button, and a list of hosts currently managed by orcharhino:

A list of all hosts known to orcharhino
  • The Export button (1) will save all hosts from the list of hosts (4) in a CSV file. The file will include one host per line, where each host is a comma separated list consisting of the content of the Name, Operating system, Environment, Model, and Host group columns of the list of hosts (4).
  • The Select Action menu (2) is used to perform bulk actions upon hosts. (See Performing Bulk Actions below).
  • The Create Host button (3) will take you to the create host page. (See also: Create Host).
  • Clicking on the name of a host in the Name column (5) of the list of hosts (4) will take you to the host overview page for that host. (See Viewing a Host below).
  • Clicking on the name of a host group in the Host group column (6) of the list of hosts (4) will take you to the edit host group page for that host group.
  • Selecting Edit from the Actions column will take you to the edit host page for that host. (See Editing a Host below).
  • Selecting Clone from the Actions column will take you to a clone host page for that host. (See Cloning a Host below).

Creating a Host

The create host page can be accessed via the Create Host button:

Hosts > All hosts >> Create Host

Clicking the Create Host button, will take you to the create host page. Please see: Create Host for documentation on host creation.

Editing a Host

The edit host page (for a given host) can be accessed via the list of hosts:

Hosts > All hosts >> list of hosts > Actions column > Edit

This page is essentially the same as the create host page, with the difference that relevant fields will be prefilled with the settings of the host being edited:

Edit a host
  • Fields that cannot be changed for an existing host will be greyed out. If you want to change those settings consider cloning the host instead (See: Cloning a Host below).
  • The Unmanage host button (1) (only available if the host being edited is managed) stops that orcharhino manages DHCP/Provisioning/Puppet for this host.
  • The Disassociate host button (2) (only available if the host being edited runs as a virtual machine) will disassociate orcharhino’s host entry from the underlying virtual machine. This means the host entry could (for example) be deleted without deleting the underlying virtual machine. Disassociated hosts can be reassociated via the relevant compute resource overview page. (See also Viewing a Compute Resource).
  • Note that there are several additional tabs (3) to the one displayed above.
  • See also the Create Host page for more information on the various fields and tabs in the above screen shot.
  • Remember to click Submit (4) to save your changes.

Cloning a Host

The clone host page (for a given host) can be accessed via the list of hosts:

Hosts > All hosts >> list of hosts > Actions column > Clone

Cloning a host allows you to create a new host, that will inherit the settings of the host being cloned. The clone host page (for a given host) is essentially the same as the Create Host page, with the difference that most fields will be prefilled with the settings of the host being cloned:

Clone a host
  • The cloned host will need to be given a new Name (2).
  • Note that there are several additional tabs (1) to the one displayed above.
  • See also the Create Host page for more information on the various fields and tabs in the above screen shot.
  • Remember to click Submit (3) to save your changes.

Performing Bulk Actions

It is possible to perform bulk actions on several hosts at once, by selecting the desired hosts in the first column of the all hosts list, and using the Select Action drop down menu to select the desired action, as follows:

Avaiable bulk actions
  • The check box in the top left corner (1) of the all hosts list can be used to select (or deselect) all hosts at once.
  • The available actions are detailed further in the table below.
  • Clicking on the desired action will open the bulk action window for that action. The following screenshot displays the bulk action window for the Assign Location action (by way of example):
Bulk action: assign location
  • The bulk action window will include a list of hosts that are about to be changed (1).
  • If the “Keep selected hosts for future action” check box (2) is selected, the current host selection will be retained for further bulk actions once the hosts page reloads.
  • Each bulk action window will include an area for options specific to each individual bulk action (3).
  • Remember to click Submit (4) to save your changes.

The following table describes each bulk action in turn:

Action Description
Change Group Change the associated host group (See also: Host Groups)
Build Hosts Rebuild the selected hosts (blank reinstall, will eliminate all data)
Change Environment Change / clear the lifecycle environment (See also: Lifecycle Environments)
Edit Parameters Change the value of existing host parameters
Disable Notifications Disable alerts for selected hosts
Enable Notifications Enable alerts for selected hosts
Disassociate Hosts Disassociate selected hosts from their virtual machines (See also: Compute Resources)
Rebuild Config Rebuild orchestration configuration
Assign Organization Change the organization selected hosts belong to (See also: Organizations)
Assign Location Change the location selected hosts belong to (See also: Locations)
Change Owner Change what user/groups own the selected hosts
Change Puppet Master Change Puppet Master
Change Puppet CA Change Puppet CA
Change Power State Change the power state of the selected hosts
Delete Hosts Delete the selected hosts
Play Ansible roles For each selected host, run the Ansible playbook that includes all roles associated with that host. orcharhino will run these playbooks as tasks. (See also: Tasks).
Schedule Remote Job Schedule a job for remote execution (See also: Jobs)
Assign Compliance Policy (Only available with OpenSCAP Plugin) Choose a compliance policy that will be applied to the selected hosts. (See also Compliance Policies Page).
Unassign Compliance Policy (Only available with OpenSCAP Plugin) Choose a compliance policy that will be removed from the selected hosts. (See also Compliance Policies Page).
Change OpenSCAP Proxy (Only available with OpenSCAP Plugin) Change what smart proxy is assigned to the selected hosts for OpenSCAP management. (See also Smart Proxies).

Viewing a Host

The host overview page (for a given host) can be accessed via the list of hosts:

Hosts > All hosts >> list of hosts > Name column > name of a host

A host overview page bundles a wealth of information and a number of actions relating to the host in question. The precise look and full list of features of the overview page may vary depending both on how the host in question is configured (for example whether it uses puppet) and what orcharhino plugins are installed.

The following screen shot aims to provide an example including a maximum feature set (irrespective of whether there exists a realistic use case for a so configured host):

Host details
  • The main button area (1) includes several buttons to perform various actions.
  • The Details area (2) includes several buttons for displaying various details.
  • The tab area (3) will display various information depending on what tab is selected. The above screenshot displays the Properties tab. The individual tabs are discussed in more detail further down this page.
  • The Console button (greyed out if the host is powered off) from the main button area (1) will open a console terminal via a VNC connection to the host in question.
  • The Run Salt button (only available if the host is configured using salt) from the main button area (1) will trigger a state.highstate run on the host to apply any available salt configuration.
  • The Schedule Remote Job button from the main button area (1) will take you to the job invocation page with the Search query field prefilled with name ^ (<host_being_viewed>).
  • The Ansible roles button from the main button area (1) will run the Ansible playbook that includes all roles associated with the host being viewed. orcharhino will run these playbooks as a task and clicking the button will take you to the relevant task page.
  • The Edit button from the main button area (1) will take you to the edit host page for the host being viewed. (See also Editing a Host above).
  • The Clone button from the main button area (1) will take you to the clone host page for the host being viewed. (See also Cloning a Host above).
  • The Build button from the main button area (1) will mark the host being viewed for a rebuild on the next time it boots. This will completely reprovision (reinstall) the host, thus deleting all it’s data!
  • The Power On/Off button from the main button area (1) will change the power state of the host being viewed.
  • The Run puppet button (only available if the host is being managed by puppet, greyed out if puppet run is not enabled) from the main button area (1) will apply any available puppet configuration.
  • The Delete button from the main button area (1) will delete the host being viewed from orcharhino. This will also delete any underlying virtual machines from the relevant compute resource. (See also: Compute Resources).
  • The Audits button from the Details area (2) will take you to the audits page with host = <host_being_viewed> in the filter bar. (See also: Audits and Filter Bars).
  • The Facts button (only available if the host has reported some facts) from the Details area (2) will take you to the facts page with host = <host_being_viewed> in the filter bar. (See also: Facts and Filter Bars).
  • The Reports button (only available if there are puppet reports for the host) from the Details area (2) will take you to the reports page with host = <host_being_viewed> in the filter bar. (See also: Config Management and Filter Bars).
  • The YAML button from the Details area (2) will take you to a puppet external nodes YAML dump. That is, a plain text file written in the YAML language, that lists all host parameters that are being supplied to the puppet master.
  • The Salt ENC button (only available if the host has a salt environment) from the Details area (2) will take you to a salt external nodes YAML dump. That is, a plain text file written in the YAML language, that lists all host parameters that are being supplied to the salt master.
  • The Content button (only available if the host uses orcharhino’s content management) from the Details area (2) will take you to the content host overview page for the host being viewed.

Note

The console feature of the orcharhino web interface requires the use of a https connection. This may in turn require importing the orcharhino servers ssl certificate into your browser. This certificate can be obtained at http://<orcharhino_host>.<domain>/pub/katello-server-ca.crt.


The following screen shot shows the tab area of an example host overview page with the Properties tab selected:

Properties tab
  • The Properties tab displays various basic information about the orcharhino host. It provides a basic overview.

The following screen shot shows the tab area of an example host overview page with the Metrics tab selected:

Metrics tab
  • The Metrics tab displays information on puppet runs for the host being viewed.

The following screen shot shows the tab area of an example host overview page with the Templates tab selected:

Templates tab
  • The Templates tab displays a list of templates used during the provisioning of the host being viewed. (See also: Provisioning Setup and Templates).
  • Selecting Edit (1) for a given template, will take you to the edit template page for that template. (See also: Viewing and/or Editing a Template).
  • Selecting Review (1) for a given template, will show you the code as generated from the template, for the host being viewed.
  • Note that the list of templates only displays the template type, but not the templates name in the list. However, the name of a template can be seen on the edit template page which can be reached by selecting Edit (1). (See also: Viewing and/or Editing a Template).

The following screen shot shows the tab area of an example host overview page with the VM tab (only available if the host being viewed runs as a virtual machine on some compute resource) selected:

VM tab
  • The VM tab displays information on the virtual machine that the orcharhino host is running on.
  • See also the Compute Resources page (especially the Viewing a Virtual Machine subsubsection) for more information on virtual machines.

The following screen shot shows the tab area of an example host overview page with the NICs tab (short for Network Interface Card) selected:

Nics tab
  • The NICs tab will list all the network interfaces of the host being viewed. It displays basic information on those interfaces.
  • The subnet entry (1) includes a link to the relevant edit subnet page.

The Snapshots tab allows orcharhino users to access the snapshot functionality of a VMware type compute resource (see also Compute Resources) from within orcharhino. VMware’s snapshot feature allows you to take a “snapshot” of a virtual machine at a given point in time. The virtual machine can then be rolled back to it’s state at the time the snapshot was taken, thus providing a system recovery point. Best practice might involve creating snapshots before important system upgrades.

The following screen shot shows the tab area of an example host overview page with the Snapshots tab (only available if the host being viewed runs on a VMware type compute resource) selected. The Snapshots tab includes a Create button and a list of snapshots:

Snapshots tab
  • The Snapshots tab allows the user to create and manage snapshots of the host being viewed.
  • The Create button (1) will create a snapshot of the current state of the host being viewed. The snapshot must be provided with a name, and may be provided with a description in the fields (2) provided.
  • The name and description of existing snapshots may be edited using the edit buttons (3) provided.
  • Selecting Rollback (4) from the Actions column will rollback the state of the host to the snapshot in question.
  • Selecting Delete (4) from the Actions column will delete the snapshot in question.

Important

Newer snapshots will include lots of back references to older snapshots. This can be inefficient if too many snapshots are kept at the same time. It is recommended to limit the number of snapshots to no more than three per host. Consider deleting older snapshots when creating new ones.