Struct HostBuilder 

pub struct HostBuilder { /* private fields */ }

Builder for creating instances of Host.

Provides a fluent interface for constructing a Host object with optional fields, allowing for more readable and maintainable object construction.

Examples

use opsview::config::{Host, HostBuilder, MonitoringCluster, HostGroup, HostTemplate};
use opsview::prelude::*;

let some_monitoring_cluster = MonitoringCluster::builder()
   .name("example_monitoring_cluster")
   .build()
   .unwrap();

let parent_hostgroup = HostGroup::minimal("Opsview").unwrap();

let some_hostgroup = HostGroup::builder()
  .name("example_hostgroup")
  .parent(parent_hostgroup)
  .build()
  .unwrap();

let some_hosttemplates = ConfigObjectMap::<HostTemplate>::new();

let host = Host::builder()
    .name("example_host")
    .monitored_by(some_monitoring_cluster)   // T: MonitoringClusterRef
    .hostgroup(some_hostgroup)               // T: HostGroup
    .hosttemplates(&some_hosttemplates)      // T: ConfigObjectMap<HostTemplate>
    .ip("192.168.1.1")
    .check_interval(5)
    .build()
    .unwrap();

assert_eq!(host.name, "example_host".to_string());

Implementations

impl HostBuilder

pub fn alias(self, alias: &str) -> Self

Sets the alias field.

Arguments

• alias - The alias of the Host.

pub fn business_components( self, business_components: &ConfigObjectMap<BSMComponent>, ) -> Self

Sets the business_components field.

Arguments

• business_components - A reference to a ConfigObjectMap of BSMComponent objects for the Host.

pub fn check_attempts(self, check_attempts: u64) -> Self

Sets the check_attempts field.

Arguments

• check_attempts - Number of check attempts before a state change.

pub fn check_command(self, check_command: HostCheckCommand) -> Self

Sets the check_command field.

Arguments

• check_command - The HostCheckCommand defining the check to be performed on the Host.

pub fn check_interval(self, check_interval: u64) -> Self

Sets the check_interval field.

Arguments

• check_interval - Interval between checks.

pub fn check_period(self, check_period: TimePeriod) -> Self

Sets the check_period field.

Arguments

• check_period - A TimePeriod during which checks are performed.

pub fn clear_alias(self) -> Self

Clears the alias field.

pub fn clear_business_components(self) -> Self

Clears the business_components field.

pub fn clear_check_attempts(self) -> Self

Clears the check_attempts field.

pub fn clear_check_command(self) -> Self

Clears the check_command field.

pub fn clear_check_interval(self) -> Self

Clears the check_interval field.

pub fn clear_check_period(self) -> Self

Clears the check_period field.

pub fn clear_enable_snmp(self) -> Self

Clears the enable_snmp field.

pub fn clear_event_handler(self) -> Self

Clears the event_handler field.

pub fn clear_event_handler_always_exec(self) -> Self

Clears the event_handler_always_exec field.

pub fn clear_flap_detection_enabled(self) -> Self

Clears the flap_detection_enabled field.

pub fn clear_hashtags(self) -> Self

Clears the keywords field. Alias for clear_keywords().

pub fn clear_hostattributes(self) -> Self

Clears the Hostattributes field.

pub fn clear_hostgroup(self) -> Self

Clears the Hostgroup field.

pub fn clear_hosttemplates(self) -> Self

Clears the Hosttemplates field.

pub fn clear_icon(self) -> Self

Clears the icon field.

pub fn clear_ip(self) -> Self

Clears the ip field.

pub fn clear_keywords(self) -> Self

Clears the keywords field.

pub fn clear_monitored_by(self) -> Self

Clears the monitored_by field.

pub fn clear_name(self) -> Self

Clears the name field.

pub fn clear_nmis_node_type(self) -> Self

Clears the nmis_node_type field.

pub fn clear_notification_interval(self) -> Self

Clears the notification_interval field.

pub fn clear_notification_options(self) -> Self

Clears the notification_options field.

pub fn clear_notification_period(self) -> Self

Clears the notification_period field.

pub fn clear_other_addresses(self) -> Self

Clears the other_addresses field.

pub fn clear_parents(self) -> Self

Clears the parents field.

pub fn clear_rancid_autoenable(self) -> Self

Clears the rancid_autoenable field.

pub fn clear_rancid_connection_type(self) -> Self

Clears the rancid_connection_type field.

pub fn clear_rancid_password(self) -> Self

Clears the rancid_password field.

pub fn clear_rancid_username(self) -> Self

Clears the rancid_username field.

pub fn clear_rancid_vendor(self) -> Self

Clears the rancid_vendor field.

pub fn clear_retry_check_interval(self) -> Self

Clears the retry_check_interval field.

pub fn clear_servicechecks(self) -> Self

Clears the servicechecks field.

pub fn clear_snmp_community(self) -> Self

Clears the snmp_community field.

pub fn clear_snmp_extended_throughput_data(self) -> Self

Clears the snmp_extended_throughput_data field.

pub fn clear_snmp_max_msg_size(self) -> Self

Clears the snmp_max_msg_size field.

pub fn clear_snmp_port(self) -> Self

Clears the snmp_port field.

pub fn clear_snmp_use_getnext(self) -> Self

Clears the snmp_use_getnext field.

pub fn clear_snmp_use_ifname(self) -> Self

Clears the snmp_use_ifname field.

pub fn clear_snmp_version(self) -> Self

Clears the snmp_version field.

pub fn clear_snmpv3_authprotocol(self) -> Self

Clears the snmpv3_authprotocol field.

pub fn clear_snmpv3_privprotocol(self) -> Self

Clears the snmpv3_privprotocol field.

pub fn clear_snmpv3_username(self) -> Self

Clears the snmpv3_username field.

pub fn clear_snmpinterfaces(self) -> Self

Clears the snmpinterfaces field.

pub fn clear_tidy_ifdescr_level(self) -> Self

Clears the tidy_ifdescr_level field.

pub fn clear_use_mrtg(self) -> Self

Clears the use_mrtg field.

pub fn clear_use_nmis(self) -> Self

Clears the use_nmis field.

pub fn clear_use_rancid(self) -> Self

Clears the use_rancid field.

pub fn enable_snmp(self, enable_snmp: bool) -> Self

Sets the enable_snmp field.

pub fn event_handler(self, event_handler: &str) -> Self

Sets the event_handler field.

Arguments

• event_handler - The event handler for the Host.

pub fn event_handler_always_exec(self, event_handler_always_exec: bool) -> Self

Sets the event_handler_always_exec field.

Arguments

• event_handler_always_exec - Boolean indicating if the event handler should always execute.

pub fn flap_detection_enabled(self, flap_detection_enabled: bool) -> Self

Sets the flap_detection_enabled field.

Arguments

• flap_detection_enabled - Boolean indicating if flap detection is enabled.

pub fn hashtags(self, hashtags: &ConfigObjectMap<Hashtag>) -> Self

Sets the keywords field. Alias for keywords().

Arguments

• keywords - A reference to a ConfigObjectMap of Hashtag objects for the Host.

pub fn hostattributes(self, hostattributes: &ConfigObjectMap<Variable>) -> Self

Sets the hostattributes field.

Arguments

• hostattributes - A reference to a ConfigObjectMap of Variable objects for the Host.

pub fn hostgroup(self, hostgroup: HostGroup) -> Self

Sets the hostgroup field.

Arguments

• hostgroup - The HostGroup object for the Host.

pub fn hosttemplates( self, hosttemplates: &ConfigObjectMap<HostTemplate>, ) -> Self

Sets the hosttemplates field.

Arguments

• hosttemplates - A reference to a ConfigObjectMap of HostTemplate objects for the Host.

pub fn icon(self, icon: HostIcon) -> Self

Sets the icon field.

Arguments

• icon - The HostIcon associated with the Host.

pub fn ip(self, ip: &str) -> Self

Sets the ip field.

Arguments

• ip - IP address of the Host.

pub fn keywords(self, keywords: &ConfigObjectMap<Hashtag>) -> Self

Sets the keywords field.

Arguments

• keywords - A reference to a ConfigObjectMap of Hashtag objects for the Host.

pub fn monitored_by(self, monitored_by: MonitoringCluster) -> Self

Sets the monitored_by field.

Arguments

• monitored_by - The MonitoringCluster responsible for monitoring the Host.

pub fn nmis_node_type(self, nmis_node_type: &str) -> Self

Sets the nmis_node_type field.

Arguments

• nmis_node_type - NMIS node type.

pub fn notification_interval(self, notification_interval: u64) -> Self

Sets the notification_interval field.

Arguments

• notification_interval - Interval between notifications.

pub fn notification_options(self, notification_options: &str) -> Self

Sets the notification_options field.

Arguments

• notification_options - Notification options for the Host. Valid options are:
  • d - send notifications on DOWN state
  • u - send notifications on UNREACHABLE state
  • r - send notifications on recovery (UP state)
  • f - send notifications when the host starts and stops flapping

Multiple options can be specified, separated by commas.

Example

“d,u,r”

pub fn notification_period(self, notification_period: TimePeriod) -> Self

Sets the notification_period field.

Arguments

• notification_period - A TimePeriod during which notifications are sent.

pub fn other_addresses(self, other_addresses: &str) -> Self

Sets the other_addresses field.

Arguments

• other_addresses - Additional addresses for the Host.

pub fn parents(self, parents: &ConfigObjectMap<Host>) -> Self

Sets the parents field.

Arguments

• parents - A reference to a ConfigObjectMap of parent Host objects.

pub fn rancid_autoenable(self, rancid_autoenable: bool) -> Self

Sets the rancid_autoenable field.

Arguments

• rancid_autoenable - Boolean indicating whether RANCID auto-enable is active.

pub fn rancid_connection_type( self, rancid_connection_type: RancidConnectionType, ) -> Self

Sets the rancid_connection_type field.

Arguments

• rancid_connection_type - RANCID connection type.

pub fn rancid_password(self, rancid_password: &str) -> Self

Sets the rancid_password field.

Arguments

• rancid_password - Password for RANCID.

pub fn rancid_username(self, rancid_username: &str) -> Self

Sets the rancid_username field.

Arguments

• rancid_username - Username for RANCID.

pub fn rancid_vendor(self, rancid_vendor: RancidVendor) -> Self

Sets the rancid_vendor field.

Arguments

• rancid_vendor - The RancidVendor for the Host.

pub fn retry_check_interval(self, retry_check_interval: u64) -> Self

Sets the retry_check_interval field.

Arguments

• retry_check_interval - Interval between retry checks.

pub fn servicechecks( self, servicechecks: &ConfigObjectMap<ServiceCheck>, ) -> Self

Sets the servicechecks field.

Arguments

• servicechecks - A reference to a ConfigObjectMap of ServiceCheck objects for the Host.

pub fn snmp_community(self, snmp_community: &str) -> Self

Sets the snmp_community field.

Arguments

• snmp_community - SNMP community string.

pub fn snmp_extended_throughput_data( self, snmp_extended_throughput_data: bool, ) -> Self

Sets the snmp_extended_throughput_data field.

Arguments

• snmp_extended_throughput_data - Boolean indicating whether extended throughput data is collected via SNMP.

pub fn snmp_max_msg_size(self, snmp_max_msg_size: u64) -> Self

Sets the snmp_max_msg_size field.

Arguments

• snmp_max_msg_size - Maximum SNMP message size.

pub fn snmp_port(self, snmp_port: u64) -> Self

Sets the snmp_port field.

Arguments

• snmp_port - SNMP port number.

pub fn snmp_use_getnext(self, snmp_use_getnext: bool) -> Self

Sets the snmp_use_getnext field.

Arguments

• snmp_use_getnext - Boolean indicating whether SNMP GETNEXT requests are used.

pub fn snmp_use_ifname(self, snmp_use_ifname: bool) -> Self

Sets the snmp_use_ifname field.

Arguments

• snmp_use_ifname - Boolean indicating whether SNMP interface names are used.

pub fn snmp_version(self, version: SNMPVersion) -> Self

Sets the snmp_version field.

Arguments

• version - The SNMPVersion to use.

pub fn snmpv3_authprotocol(self, protocol: SNMPV3AuthProtocol) -> Self

Sets the snmpv3_authprotocol field.

Arguments

• protocol - SNMPV3AuthProtocol for SNMPv3.

pub fn snmpv3_authpassword(self, snmpv3_authpassword: &str) -> Self

Sets the snmpv3_authpassword field.

Arguments

• snmpv3_authpassword - Authentication password for SNMPv3.

pub fn snmpv3_privprotocol(self, protocol: SNMPV3PrivProtocol) -> Self

Sets the snmpv3_privprotocol field.

Arguments

• protocol - SNMPV3PrivProtocol for SNMPv3.

pub fn snmpv3_privpassword(self, snmpv3_privpassword: &str) -> Self

Sets the snmpv3_privpassword field.

Arguments

• snmpv3_privpassword - Privacy password for SNMPv3.

pub fn snmpv3_username(self, snmpv3_username: &str) -> Self

Sets the snmpv3_username field.

Arguments

• snmpv3_username - Username for SNMPv3.

pub fn snmpinterfaces(self, snmpinterfaces: SNMPInterfaces) -> Self

Sets the snmpinterfaces field.

Arguments

• snmpinterfaces - A number of SNMPInterfaces

pub fn tidy_ifdescr_level(self, tidy_ifdescr_level: &str) -> Self

Sets the tidy_ifdescr_level field.

Arguments

• tidy_ifdescr_level - Interface description level for tidying.

pub fn use_mrtg(self, use_mrtg: bool) -> Self

Sets the use_mrtg field.

Arguments

• use_mrtg - Boolean indicating whether MRTG is used for the Host.

pub fn use_nmis(self, use_nmis: bool) -> Self

Sets the use_nmis field.

Arguments

• use_nmis - Boolean indicating whether NMIS is used for the Host.

pub fn use_rancid(self, use_rancid: bool) -> Self

Sets the use_rancid field.

Arguments

• use_rancid - Boolean indicating whether RANCID is used for the Host.

Trait Implementations

impl Builder for HostBuilder

fn new() -> Self

Creates a new instance of HostBuilder with default values.

Initializes a new builder for creating a Host object with all fields in their default state.

fn name(self, name: &str) -> Self

Sets the name field.

Arguments

• name - Name of the Host.

fn build(self) -> Result<Host, OpsviewConfigError>

Completes the construction of a Host object.

Validates the current state of the HostBuilder and assembles a Host object. This method checks that all required fields are set and any constraints are met. If a required field is missing or a constraint is violated, an error is returned.

Errors

Returns an error if any required fields are not set or if there are inconsistencies in the provided data.

Returns

On success, returns a Result containing the constructed Host object. On failure, returns a Result containing an OpsviewConfigError.

type ConfigObject = Host

impl Clone for HostBuilder

fn clone(&self) -> HostBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HostBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HostBuilder

fn default() -> Self

Returns the “default value” for a type.