Black List

h6. Contents

This page reviews the Device Management Black List feature.
{toc:minLevel=4|maxLevel=4|printable=false}

h4. 1.0 About Black List

The Black List feature allows you to stop Cloud Hub discovered hosts from being included in the system monitoring. Hosts that are black listed will not be displayed, monitored, distribute notifications, be counted against the system license limit, and overall be reported on within the system. This can be useful for hosts that are not currently being used but may be in the future. Black List hosts are still seen by the system but because they are added to the list they will be _hidden_ in the system operations.

Cloud Hub consults this list for references to hosts that will not be discovered and added to the Foundation database and used against the license limit. This is useful when Cloud Hub discovers devices like _templates_ and _test servers_ in the same location where production devices are found. To start monitoring black listed hosts again, you would remove the host from the list.

{note}Blacklisting at present is only effective for hosts discovered by Cloud Hub. Hosts monitored by Smart Cacti Feeder, Nagios, Syslog, SNMPTrap, SCOM Feeder, etc may not be blacklisted (entries made in the Black List table will be ignored).
{note}

h4. 2.0 Adding Hosts

[!video_button.png!|^how to add host to black list.mp4]
Follow these steps to add a host to the Black List. As previously mentioned hosts that are black listed will not be displayed, monitored, distribute notifications, be counted against the system license limit, and overall be reported on within the system. 
# As an Administrator, select *GroundWork Administration* > *Device Management* > *Black List*.
# Select the *+* icon and the *New Black List Record* dialog will be displayed. Enter the exact *host name* to add to the black list.
# Click the *Add* button. 
# Go to the Status view and the host will not be displayed, you can also search for the host using the Search tab.
\\
\\
Figure: New Black List Record dialog
\\ !bookshelf_black_list_01.jpg!

h4. 3.0 Adding Regular Expressions

Regular expressions are patterns used to match character combinations in strings. In JavaScript, regular expressions are also objects. You can select several hosts by using a regex in the Host Name field for the Black List feature. Below we show an example of how to use the Black List feature with a regex. It is recommended to use java/javascript regex patterns instead of using file path wildcard syntax. 

{color:#333333}For additional information regarding regular expressions you may want to visit:{color}
* Online Regular Expression Tool: [http://regexr.com/]
* Zytrax Info Regular Expression User Guide: [http://zytrax.com/tech/web/regex.htm]
* MDN Regular Expressions Reference: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions]
* Java Class Pattern Reference:  [https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html]

h5. 3.1 Example #1

* In this first image we show the Status view for a VMware Cloud Hub connection. You can see the host group *NET:VM Network* which lists hosts that include the string "ELK" and "elk".
\\
\\
Figure: Status view of host group
\\ !bookshelf_black_list_02.jpg!

* Next we use the regular expression *(elk-)\w\+* where *(*{_}captures the group character codes{_}*)*, *\w* matches any word character (alphanumeric and underscore), and *+* matches one or more of the preceding token.
\\
\\
Figure: RegEx (elk-)\w+ 
\\ !bookshelf_black_list_03.jpg!

* This captures all of the hosts in our example except *ELK-GW7-1* and *elk_mgmt_ubuntu_14*. You can see the remaining hosts by searching for "elk".
\\
\\
Figure: Searching for hosts 
\\ !bookshelf_black_list_04.jpg!

h5. 3.2 Additional examples

| (wingdma-)\w\* | wingdma-dev |

h4. 4.0 Removing Black List Records

To {color:#333333}start monitoring the black listed hosts again, you would remove the host from the list.{color}
# As an administrator, select *GroundWork Administration* > *Device Management* > *Black List*. You may also use the *Filter Hosts* box to search for specific hosts to manage.
# On the left, check the *host name* box for each of the host records to be removed.
# Click the *Trashcan* icon, then click *Delete*.
\\
\\
Figure: Check host to delete Black List record
\\ !bookshelf_black_list_05.jpg!
{html}<script>
jQuery(document).ready(function() {
jQuery(".wiki-content a").attr("target", "_blank");
});
</script>{html}