Windows plugin help text

Overview Copied

This page provides a comprehensive list of plugins available in Windows builds of the Infrastructure Agent, along with their corresponding help text.

Windows plugins Copied

check_active_directory Copied

check_active_directory 

Copyright (C) 2003 - 2023 Opsview Limited. All rights reserved.
Monitors Microsoft Active Directory.

Usage:
	check_active_directory [OPTIONS]

Default Options:
	-h	Show this help message

Optional arguments:
        -v, -Verbose
            Verbose mode - always display all output
        -w, -Warning
            The warning levels (comma separated)
        -c, -Critical
            The critical levels (comma separated)

        Mode specific arguments:
            -Username
                Username for remote windows host e.g user@DOMAIN.COM
            -Password
                Password for remote windows host
            -Authentication
                Authentication type to use

        Supported modes:
            - AD.Replication.IOBytesRate
            - AD.Replication.IOObjectsRate
            - AD.Replication.IOValuesRate
            - AD.Replication.Synchronizations
            - AD.Services.ClientBindsRate
            - AD.Services.DirectoryIORate
            - AD.Services.DirectorySearches
            - AD.Services.LDAPBindTime
            - AD.Services.LDAPClientSessions
            - AD.Services.LDAPSearches
            - AD.Services.LDAPSearchesRate
            - AD.Services.LDAPSuccessfulBindsRate
            - AD.Services.LDAPWrites
            - AD.Services.LDAPWritesRate
            - AD.Services.KC.IO
            - AD.Services.LSA.IO
            - AD.Services.NSPI.IO
            - AD.Services.ADWS
            - AD.Threads.AsynchronousThreadQueue
            - AD.Threads.LDAPAsynchronousThreadQueue
            - AD.AddressBook.ClientSessions
            - AD.AddressBook.BrowsesRate
            - AD.AddressBook.LookupsRate
            - AD.AddressBook.PropertyReadsRate
            - AD.AddressBook.SearchesRate
            - AD.SAM.ReadsWrites
            - AD.SAM.ComputerCreationsRate
            - AD.SAM.MachineCreationAttemptsRate
            - AD.SAM.PasswordChangesRate
            - AD.SAM.UserCreationsRate
            - AD.SAM.GlobalCatalogEvaluationsRate
            - AD.SAM.UserCreationAttemptsRate
            - AD.DNS.TotalQueries
            - AD.DNS.QueriesRate
            - AD.DNS.RecursiveQueriesRate
            - AD.Database.DiskUsage
            - AD.Database.OperationalStatus
            - AD.Database.HealthStatus
            - AD.Database.FileSize

check_clustergroup Copied

NAME
    C:\Program Files\Infrastructure Agent\plugins\check_clustergroup.ps1
    
SYNOPSIS
    This is a Powershell script to check state of Windows ClusterGroup Status
    You need the FailOverCluster feature installed on your Windows server for this check to work
    
    
SYNTAX
    C:\Program Files\Infrastructure Agent\plugins\check_clustergroup.ps1 [-help] [[-ClusterGroup] <String[]>] 
    [<CommonParameters>]
    
    
DESCRIPTION
    This script will check the state of the Windows ClusterGroup Status.
    

PARAMETERS
    -help [<SwitchParameter>]
        
    -ClusterGroup <String[]>
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216). 
    
    -------------------------- EXAMPLE 1 --------------------------
    
    PS C:\>./check_clustergroup.ps1
    
    Check All Cluster Groups
    
    
    
    
    -------------------------- EXAMPLE 2 --------------------------
    
    PS C:\>./check_clustergroup.ps1 -ClusterGroup CLGRP1,CLGRP2,CLGRP3
    
    Check selected Cluster Groups
    
    
    
    
REMARKS
    To see the examples, type: "get-help C:\Program Files\Infrastructure Agent\plugins\check_clustergroup.ps1 -examples".
    For more information, type: "get-help C:\Program Files\Infrastructure Agent\plugins\check_clustergroup.ps1 -detailed".
    For technical information, type: "get-help C:\Program Files\Infrastructure Agent\plugins\check_clustergroup.ps1 -full".
    For online help, type: "get-help C:\Program Files\Infrastructure Agent\plugins\check_clustergroup.ps1 -online"

check_cp_cpu_model Copied

Copyright (C) 2003-2023 ITRS Group Limited. All rights reserved.
This plugin produces statistics for capacity planner for your Windows system.

Plugin Options:
  -m | --mode  Metric to Monitor
  Default Options:
  -h | --help  Show this help message

Capacity Planner Opspack Plugin supports the following modes:
  * cpu_model - Report the CPU model
  * filesystem_capacity - Report filesystem capacity, filesystems can be
                          by supplying options
  * filesystem_utilization - Report the current filesystem utilization,
                             filesystems can be by supplying options
  * hardware_model - Report the hardware model
  * hardware_vendor - Report the hardware vendor
  * os_version - Report the friendly OS name
  * server_specification - Report the physical cores, logical core, CPU clock
                           speed and memory capacity
  * server_utilization - Report the current CPU and memory utilization

Mode specific Options
  --exclude-filesystem - A comma seperated list of filesystem types to exclude
  --exclude-mount - A comma seperated list of filesystem mounts to exclude

check_cp_filesystem_capacity Copied

Copyright (C) 2003-2023 ITRS Group Limited. All rights reserved.
This plugin produces statistics for capacity planner for your Windows system.

Plugin Options:
  -m | --mode  Metric to Monitor
  Default Options:
  -h | --help  Show this help message

Capacity Planner Opspack Plugin supports the following modes:
  * cpu_model - Report the CPU model
  * filesystem_capacity - Report filesystem capacity, filesystems can be
                          by supplying options
  * filesystem_utilization - Report the current filesystem utilization,
                             filesystems can be by supplying options
  * hardware_model - Report the hardware model
  * hardware_vendor - Report the hardware vendor
  * os_version - Report the friendly OS name
  * server_specification - Report the physical cores, logical core, CPU clock
                           speed and memory capacity
  * server_utilization - Report the current CPU and memory utilization

Mode specific Options
  --exclude-filesystem - A comma seperated list of filesystem types to exclude
  --exclude-mount - A comma seperated list of filesystem mounts to exclude

check_cp_filesystem_utilization Copied

Copyright (C) 2003-2023 ITRS Group Limited. All rights reserved.
This plugin produces statistics for capacity planner for your Windows system.

Plugin Options:
  -m | --mode  Metric to Monitor
  Default Options:
  -h | --help  Show this help message

Capacity Planner Opspack Plugin supports the following modes:
  * cpu_model - Report the CPU model
  * filesystem_capacity - Report filesystem capacity, filesystems can be
                          by supplying options
  * filesystem_utilization - Report the current filesystem utilization,
                             filesystems can be by supplying options
  * hardware_model - Report the hardware model
  * hardware_vendor - Report the hardware vendor
  * os_version - Report the friendly OS name
  * server_specification - Report the physical cores, logical core, CPU clock
                           speed and memory capacity
  * server_utilization - Report the current CPU and memory utilization

Mode specific Options
  --exclude-filesystem - A comma seperated list of filesystem types to exclude
  --exclude-mount - A comma seperated list of filesystem mounts to exclude

check_cp_hardware_model Copied

Copyright (C) 2003-2023 ITRS Group Limited. All rights reserved.
This plugin produces statistics for capacity planner for your Windows system.

Plugin Options:
  -m | --mode  Metric to Monitor
  Default Options:
  -h | --help  Show this help message

Capacity Planner Opspack Plugin supports the following modes:
  * cpu_model - Report the CPU model
  * filesystem_capacity - Report filesystem capacity, filesystems can be
                          by supplying options
  * filesystem_utilization - Report the current filesystem utilization,
                             filesystems can be by supplying options
  * hardware_model - Report the hardware model
  * hardware_vendor - Report the hardware vendor
  * os_version - Report the friendly OS name
  * server_specification - Report the physical cores, logical core, CPU clock
                           speed and memory capacity
  * server_utilization - Report the current CPU and memory utilization

Mode specific Options
  --exclude-filesystem - A comma seperated list of filesystem types to exclude
  --exclude-mount - A comma seperated list of filesystem mounts to exclude

check_cp_hardware_vendor Copied

Copyright (C) 2003-2023 ITRS Group Limited. All rights reserved.
This plugin produces statistics for capacity planner for your Windows system.

Plugin Options:
  -m | --mode  Metric to Monitor
  Default Options:
  -h | --help  Show this help message

Capacity Planner Opspack Plugin supports the following modes:
  * cpu_model - Report the CPU model
  * filesystem_capacity - Report filesystem capacity, filesystems can be
                          by supplying options
  * filesystem_utilization - Report the current filesystem utilization,
                             filesystems can be by supplying options
  * hardware_model - Report the hardware model
  * hardware_vendor - Report the hardware vendor
  * os_version - Report the friendly OS name
  * server_specification - Report the physical cores, logical core, CPU clock
                           speed and memory capacity
  * server_utilization - Report the current CPU and memory utilization

Mode specific Options
  --exclude-filesystem - A comma seperated list of filesystem types to exclude
  --exclude-mount - A comma seperated list of filesystem mounts to exclude

check_cp_os Copied

Copyright (C) 2003-2023 ITRS Group Limited. All rights reserved.
This plugin produces statistics for capacity planner for your Windows system.

Plugin Options:
  -m | --mode  Metric to Monitor
  Default Options:
  -h | --help  Show this help message

Capacity Planner Opspack Plugin supports the following modes:
  * cpu_model - Report the CPU model
  * filesystem_capacity - Report filesystem capacity, filesystems can be
                          by supplying options
  * filesystem_utilization - Report the current filesystem utilization,
                             filesystems can be by supplying options
  * hardware_model - Report the hardware model
  * hardware_vendor - Report the hardware vendor
  * os_version - Report the friendly OS name
  * server_specification - Report the physical cores, logical core, CPU clock
                           speed and memory capacity
  * server_utilization - Report the current CPU and memory utilization

Mode specific Options
  --exclude-filesystem - A comma seperated list of filesystem types to exclude
  --exclude-mount - A comma seperated list of filesystem mounts to exclude

check_cp_server_specification Copied

Copyright (C) 2003-2023 ITRS Group Limited. All rights reserved.
This plugin produces statistics for capacity planner for your Windows system.

Plugin Options:
  -m | --mode  Metric to Monitor
  Default Options:
  -h | --help  Show this help message

Capacity Planner Opspack Plugin supports the following modes:
  * cpu_model - Report the CPU model
  * filesystem_capacity - Report filesystem capacity, filesystems can be
                          by supplying options
  * filesystem_utilization - Report the current filesystem utilization,
                             filesystems can be by supplying options
  * hardware_model - Report the hardware model
  * hardware_vendor - Report the hardware vendor
  * os_version - Report the friendly OS name
  * server_specification - Report the physical cores, logical core, CPU clock
                           speed and memory capacity
  * server_utilization - Report the current CPU and memory utilization

Mode specific Options
  --exclude-filesystem - A comma seperated list of filesystem types to exclude
  --exclude-mount - A comma seperated list of filesystem mounts to exclude

check_cp_server_utilization Copied

Copyright (C) 2003-2023 ITRS Group Limited. All rights reserved.
This plugin produces statistics for capacity planner for your Windows system.

Plugin Options:
  -m | --mode  Metric to Monitor
  Default Options:
  -h | --help  Show this help message

Capacity Planner Opspack Plugin supports the following modes:
  * cpu_model - Report the CPU model
  * filesystem_capacity - Report filesystem capacity, filesystems can be
                          by supplying options
  * filesystem_utilization - Report the current filesystem utilization,
                             filesystems can be by supplying options
  * hardware_model - Report the hardware model
  * hardware_vendor - Report the hardware vendor
  * os_version - Report the friendly OS name
  * server_specification - Report the physical cores, logical core, CPU clock
                           speed and memory capacity
  * server_utilization - Report the current CPU and memory utilization

Mode specific Options
  --exclude-filesystem - A comma seperated list of filesystem types to exclude
  --exclude-mount - A comma seperated list of filesystem mounts to exclude

check_file_age Copied

checkfileage 

Checks file for existence and not to be older than the thresholds

Usage:
	checkfileage [OPTIONS]

Default Options:
	-h	Show this help message

Plugin Options:

        -filename <filename>

        -warn warning level in minutes (default 5 mins)

        -crit critical level in minutes (default 8 mins)

check_http Copied

Executes Windows plugins from a long running process.

    Launch without command line args then pass plugin arguments via STDIN.
    The first argument should be the name of the plugin to execute.
    Available plugins are:
    check_counter, check_cpu_load, check_drivesize, check_eventlog, check_memory, check_servicestate, check_http, check_ssl

check_microsoft_exchange Copied

check_microsoft_exchange 

Copyright (C) 2003 - 2023 Opsview Limited. All rights reserved.
Monitors Microsoft Agentless.

Usage:
	check_microsoft_exchange [OPTIONS]

Default Options:
	-h	Show this help message

Optional arguments:
    -v, -Verbose
        Verbose mode - always display all output
    -w, -Warning
        The warning levels (comma separated)
    -c, -Critical
        The critical levels (comma separated)

Required arguments:
    -n, -Hostname
        Hostname of the host to monitor
    -m, -Mode
        Mode for the plugin to run (the service check). See below for a full list of supported modes.

Mode specific arguments:
    -Queue
        Mailbox queue to monitor
    -InactiveComponents
        Comma separated list of components which are expected to be inactive
    -InactiveServices
        Comma separated list of services which are not expected to be running
    -Transport
        Authentication type to use
    -Username
        Username for remote windows host
    -Password
        Password for remote windows host
    -Scheme
        Scheme for connecting to remote windows host

Supported modes:
    - MSExStatus.Service.States
    - MSExStatus.Component.States
    - MSExMailflow.Status
    - MSExMailflow.Message.Latency
    - MSExMailflow.SMTP.Connectivity
    - MSExMailflow.SMTP.Message.Count
    - MSExMailflow.Mailbox.Failure.Rate
    - MSExMailflow.Mailbox.Queue
    - MSExMailflow.Back.Pressure.Status
    - MSExDatabase.Disk.Space
    - MSExDatabase.Backup.Status
    - MSExDatabase.Replication.Health
    - MSExDatabase.MAPI.Connectivity
    - MSExDatabase.IO
    - MSExDatabase.Instances
    - MSExDatabase.RPC.Latency
    - MSExDatabase.LDAP.Search.Time
    - MSExConnectivity.ActiveSync
    - MSExConnectivity.ECP
    - MSExConnectivity.IMAP
    - MSExConnectivity.Web.Service
    - MSExConnectivity.POP
    - MSExConnectivity.Connected.Users
    - MSExConnectivity.CAS.Latency
    - MSExConnectivity.ActiveSync.Requests

check_microsoft_exchange2013_backpressure Copied

check_microsoft_exchange2013_backpressure  

Copyright (c) 2003-2023 Opsview Limited. All rights reserved. This plugin monitors the pressure stats for your Microsoft Exchange 2013 Server. 

Usage:
        check_microsoft_exchange2013_backpressure [OPTIONS] 

Default Options:
         -h	Show this help message 

Plugin Options:

    arguments:

      -h show this help message and exit,
      -m MODE,

            Supported modes:
            DatabaseMonitor: Hard drive utilisation of the drive that stores message queue database.

            DatabaseLoggingFolderMonitor: Hard drive utilisation of the drive that stores the message queue database transaction logs.

            DiskSpaceMonitor: Hard drive utilisation of the drive that stores temp files. 

            VersionBucketsMonitor: The number of uncommitted message queue database transactions that exist in memory.

            MemoryPrivateBytesMonitor: Percentage of the total memory that's used by the EdgeTransport.exe process.

            MemoryTotalBytesMonitor: Memory utilization by all processes.

            SubmissionQueueMonitor: Number of messages in the Submission queue.

      -w WARNING,
            Value set for warning level

      -c CRITICAL,
            Value set for critical level

      -u USERNAME
            Username to Exchange server

      -p PASSWORD
            Password to Exchange server

      -s SERVER
            Name of your Exchange server

      -f FQDN
            Fully qualified domain name for you Exchange server

check_microsoft_exchange2016_backpressure Copied

check_microsoft_exchange2016_backpressure  

Copyright (c) 2003-2023 Opsview Limited. All rights reserved. This plugin monitors the pressure stats for your Microsoft Exchange 2016 Server. 

Usage:
        check_microsoft_exchange2016_backpressure [OPTIONS] 

Default Options:
         -h	Show this help message 

Plugin Options:

   arguments:

      -h show this help message and exit,
      -m MODE,

            Supported modes:

            DatabaseUsedSpace: Hard drive utilization for the drive that holds the message queue database.

            PrivateBytes: The memory that's used by the EdgeTransport.exe process.

            QueueLength: The number of messages in the Submission queue.

            SystemMemory: The memory that's used by all other processes.

            TransactionLogsUtilisation: Hard drive utilization for the drive that holds the message queue database transaction logs.

            ContentConversionUtilisation: Hard drive utilization for the drive that's used for content conversion.

            UsedVersionBuckets: The number of uncommitted message queue database transactions that exist in memory.

      -w WARNING,
            Value set for warning level

      -c CRITICAL,
            Value set for critical level

      -u USERNAME
            Username to Exchange server

      -p PASSWORD
            Password to Exchange server

      -s SERVER
            Name of your Exchange server

      -f FQDN
            Fully qualified domain name for you Exchange server

check_microsoft_exchange_counters Copied

check_microsoft_exchange_counters  

Copyright (c) 2003-2023 Opsview Limited. All rights reserved. This plugin monitors the stats for your . 

Usage:
        check_microsoft_exchange_counters [OPTIONS] 

Default Options:
         -h	Show this help message 

Plugin Options:

     arguments:

      -h show this help message and exit,
      -m MODE,

            Supported modes:

            I/ODatabaseReads: Shows the average length of time, in milliseconds (ms), per database read operation. 

            I/ODatabaseWrites: Shows the average length of time, in ms, per database write operation.

            SMPTSentMessages: Shows the number of messages sent by the SMTP server each second. Determines current load. Compare values to historical baselines.

            SMPTReceivedMessages: Shows the number of messages received by the SMTP server each second. Determines current load. Compare values to historical baselines.

            DBInstances: Shows the number of active database copies on the server.

            MailboxDeliveryQueue: Shows the number of messages queued for delivery in all queues.

            UsersOnline: Shows the number of unique users currently logged on to Outlook Web App.

            CASLatency: Shows the average latency (ms) of CAS processing time.

            MailboxServerFailureRate: Shows the percentage of connectivity related failures between this Client Access Server and MBX servers.

            ActiveSyncRequests: Shows the number of HTTP requests received from the client via ASP.NET per second.

            LDAPSearchTime: Shows the time (in ms) to send an LDAP search request and receive a response.

            RPCAverageLatency: RPC Latency average (msec) is the average latency in milliseconds of RPC requests per database

      -w WARNING,
            Value set for warning level

      -c CRITICAL,
            Value set for critical level

      -l LOCATION,
            The path to the metric

      -u USERNAME
            Username to Exchange server

      -p PASSWORD
            Password to Exchange server

      -s SERVER
            Name of your Exchange server

      -f FQDN
            Fully qualified domain name for you Exchange server

check_mountpoint Copied

Usage:
    check_mountpoint.ps1 -Warning <GB> -Critical <GB> -MountPoint <MountPointLabel>
    check_mountpoint.ps1 -Warning 15 -Critical 10 -MountPoint all
    check_mountpoint.ps1 -Warning 15 -Critical 10 -MountPoint DATA

check_ms_dns Copied

check_ms_dns  

Copyright (c) 2003-2017 Opsview Limited. All rights reserved. This plugin monitors the stats for your Microsoft DNS Server. 

Usage:
        check_ms_dns [OPTIONS] 

Default Options:
         -h	Show this help message 

Plugin Options:

        -m Metric to Monitor
        -w Warning Threshold
        -c Critical Threshold

        Default Options:

        -h    Show this help message 
 
Microsoft DNS Server Monitoring Opspack Plugin supports the following metrics:

        caching_memory - Shows the total amount of caching memory used by the DNS server
        recursive_queries_statistics - Shows the rate at which recursive queries are received, failed and timeout by the DNS server
        requests_statistics - Shows the rate at which queries are received and responses are sent by the DNS serverr

check_ms_hyperv_server Copied

check_hyperv  

Copyright (c) 2003-2023 Opsview Limited. All rights reserved. This plugin monitors the performance of Microsoft Hyper-V. 

Usage:
        check_hyperv [OPTIONS] 

Default Options:
         -h	Show this help message 

Plugin Options:

    -m Mode/Metric to Monitor
    -w Warning Threshold
    -c Critical Threshold
    -v VM Name (Used with virtual_machine_status mode) 

    Default Options:

    -h Show this help message
 
Microsoft Hyper-V Plugin supports the following modes:

    virtual_cpu_stats - CPU Usage, CPU Interrupts per second, and CPU Context Switches per second
    virtual_disk_stats - Total bytes written and read by virtual hard disks per second
    virtual_network_stats - Total bytes sent and received by virtual network adapters per second
    virtual_machines_summary - Summary of all the virtual machines and their states. Gives names of any VMs in Critical state
    uptime - Uptime of the Hyper-V server. Time since last bootup

check_ms_iis Copied

check_ms_iis  

Copyright (c) 2003-2023 Opsview Limited. All rights reserved. This plugin monitors the stats for your Microsoft Internet Information Services. 

Usage:
        check_ms_iis [OPTIONS] 

Default Options:
         -h	Show this help message 

Plugin Options:

        -m Metric to Monitor
        -w Warning Threshold
        -c Critical Threshold

        Default Options:

        -h    Show this help message 
 
Microsoft Internet Information Services Monitoring Opspack Plugin supports the following metrics:

        bytes_in_out_sec - Rate of bytes sent and recieved by IIS
        connections - Current number of active connections to the service and rate of attempted connections to the service
        requests - Rate at which HTTP requests using the get, post and put methods are made to the service per second
        service_uptime - Uptime for the web server

check_ms_sql_database_states Copied

check_mssql_database_state  

Copyright (c) 2003-2023 Opsview Limited. All rights reserved. This plugin monitors the stats for your MS SQL Database States. 

Usage:
        check_mssql_database_state [OPTIONS] 

Default Options:
         -h	Show this help message 

Plugin Options:
        -d Database Name to check the state for
        -s Server Name - Used if have multiple servers/database engines (e.g. '\MSSQLSERVER01')

        Default Options:
        -h    Show this help message

check_ms_sql_performance Copied

check_ms_sql_performance  

Copyright (c) 2003-2023 Opsview Limited. All rights reserved. This plugin monitors the stats for your Microsoft SQL Performance Metrics. 

Usage:
        check_ms_sql_performance [OPTIONS] 

Default Options:
         -h	Show this help message 

Plugin Options:

        -m Metric to Monitor
        -w Warning Threshold
        -c Critical Threshold
        -s Server Name

        Default Options:

        -h    Show this help message 
 
 Microsoft SQL Performance Metrics Monitoring Opspack Plugin supports the following metrics:

        active_transactions: Active Transactions
        average_wait: Average Wait Time
        batch_requests: Batch Requests/Sec
        buffer_hit_ratio: Buffer Cache Hit Ratio
        compilation_statistics: SQL Compilations/Sec and SQL Re-Compilations/Sec
        database_size: Database Size
        forwarded_records: Forwarded Records/Sec
        full_scans: Full Scans/sec
        latch_statistics: Average Latch Wait Time, Latch Wait Time, SuperLatch Promotions/Sec and SuperLatch Demotions/Sec
        lazy_writes: Lazy Writes/Sec
        lock_statistics: Deadlocks/Sec, Lock Requests/Sec, Lock Wait Time, Lock Timeouts/Sec and Lock Waits/Sec
        log_statistics: Log Cache Hit Ratio, Log Flush Wait Time, Log Flush Write Time and Log Growths
        paging_statistics: Checkpoint Pages/Sec, Database Pages, Page Life Expectancy, Page Lookups/Sec, Page Reads/Sec, Page Splits/Sec, Page Writes/Sec, Readahead Pages/Sec and Target Pages
        processes_blocked: Processes Blocked
        stolen_server_memory: Stolen Server Memory (Stolen Pages in KB)
        user_connections: User Connections

check_ms_sql_system Copied

check_ms_sql_system  

Copyright (c) 2003-2023 Opsview Limited. All rights reserved. This plugin monitors the stats for your Microsoft SQL System. 

Usage:
        check_ms_sql_system [OPTIONS] 

Default Options:
         -h	Show this help message 

Plugin Options:

        -m Metric to Monitor
        -w Warning Threshold
        -c Critical Threshold
        -s Server Name

        Default Options:

        -h    Show this help message 
 
MS SQL System Monitoring Opspack Plugin supports the following metrics:

        kernel_pool_statistics: Kernel Paged Pool Size and Kernel Non Paged Pool Size
        memory_utilization: Memory Utilization Percentage
        paging_statistics: Total Page File Size, Page Fault Count, Locked Page Allocations Size and Available Page File Size
        physical_memory_statistics: Available Physical Memory, Physical Memory In Use and Total Physical Memory Size
        process_physical_memory_status: Low Physical Memory Notification
        process_virtual_memory_status: Low Virtual Memory Notification
        server_listener: Server Listener
        system_cache_size: System Cache Size
        system_memory_state_description: Memory state defined from High Memory/Low Memory Resource Notifications
        virtual_address_space_statistics: Total Virtual Address Space, Virtual Address Space Available, Virtual Address Space Committed and Virtual Address Space Reserved

check_msmq Copied

check_msmq  

Copyright (c) 2003-2023 Opsview Limited. All rights reserved. This plugin monitors the stats for your Microsoft Message Queue. 

Usage:
        check_msmq [OPTIONS] 

Default Options:
         -h	Show this help message 

Plugin Options:

        -m Metric to Monitor
        -w Warning Threshold
        -c Critical Threshold

        Default Options:

        -h    Show this help message 
 
Microsoft Message Queue Monitoring Opspack Plugin supports the following metrics:

        message_rates - Shows the number of incoming and outgoing messages in all queues
        queues_stats - Shows the total number of bytes and messages in all active queues
        sessions - Shows the total number of open network sessions. A session is opened whenever a message is to be sent or received

check_services Copied

NAME
    C:\Program Files\Infrastructure Agent\plugins\check_services.ps1
    
SYNOPSIS
    This is a Powershell script to check status of Windows Services
    
    
SYNTAX
    C:\Program Files\Infrastructure Agent\plugins\check_services.ps1 [-help] [[-ServiceName] <String[]>] [[-ExcludeService] 
    <String[]>] [[-ExcludeState] <String[]>] [[-ExcludeStatus] <String[]>] [[-StartMode] <String[]>] [<CommonParameters>]
    
    
DESCRIPTION
    This script will check the status of the Windows Services. When you do not specify services using -ServiceName parameter 
    script will check all Services. You can exclude Services (-ExcludeService), Service State (-ExcludeService-State), Service 
    Status (-ExcludeStatus) and ServiceStartMode (ExcludeStartMode).
    

RELATED LINKS
    http://www.opsview.com

REMARKS
    To see the examples, type: "get-help C:\Program Files\Infrastructure Agent\plugins\check_services.ps1 -examples".
    For more information, type: "get-help C:\Program Files\Infrastructure Agent\plugins\check_services.ps1 -detailed".
    For technical information, type: "get-help C:\Program Files\Infrastructure Agent\plugins\check_services.ps1 -full".
    For online help, type: "get-help C:\Program Files\Infrastructure Agent\plugins\check_services.ps1 -online"

check_ssl Copied

Executes Windows plugins from a long running process.

    Launch without command line args then pass plugin arguments via STDIN.
    The first argument should be the name of the plugin to execute.
    Available plugins are:
    check_counter, check_cpu_load, check_drivesize, check_eventlog, check_memory, check_servicestate, check_http, check_ssl

check_windows_base Copied

check_windows_base  

Copyright (c) 2003-2023 Opsview Limited. All rights reserved. This plugin monitors the stats for your Windows system. 

Usage:
        check_windows_base [OPTIONS] 

Default Options:
         -h	Show this help message 

Plugin Options:

        -m Metric to Monitor
        -w Warning Threshold
        -c Critical Threshold

        -p Process Name

        -l Folder Location

        -f File Location

        Default Options:

        -h    Show this help message 
 
Windows Base Monitoring Opspack Plugin supports the following metrics:


        cpu_statistics - Percentage of time CPU is executing processes, Percentage of time CPU recieves interrupts, Number of processes queued but not able to use the CPU, Percentage of time CPU is in user mode
        disk_statistics - Number of reads and writes to disk per second, Number of disk requests outstanding, Percentage of time the disk is serving read or write requests
        disk_space_used_unique - Disk space for the given drive
        disk_usage - Percentage of free disk space
        file_size_unique - The size of a given file
        folder_size_unique - The size of a given folder
        memory_pages_per_sec - Number of pages per second that had to be read from disk instead of RAM
        memory_usage - Percentage of memory available
        network_in_out - Rate of packets received and sent on the network interface
        os_details - Displays the name of the operating system being monitored
        process_count - Number of instances for the given process
        process_cpu_time - Percentage of CPU time the given process uses
        system_in_out - Rate of file system read and write requests
        uptime - Uptime of the operating system. Time since last bootup
        users_count - Number of users currently on the system.

checkcounter Copied

Returns information for a given counter
Arguments:
    Counter    Defined counter to return information on
    MaxWarn    Value to trigger warning level
    MaxCrit    Value to trigger critical level

checkcpu Copied

Returns CPU load information over the last 1m/10m
Arguments:
    Warn     Value to trigger warning level
    Crit     Value to trigger critical level
    Time     Time interval (can have both time=1m and time=10m)
    ShowAll  Gives more verbose output

checkdrivesize Copied

Returns size information on the specified drive
Arguments:
    (Min|Max)(Warn|Crit)(Free|Used)
                   Threshold levels for % OR total space (B, KB, MB, etc.)
                     (e.g. MinCritFree=1GB, MaxWarnUsed=80%)
    Drive          The drive to return size information for
    CheckAll       Checks all drives
    CheckAllOthers Checks all drives, but turns the Drive option into an exclude option
    FilterType     The type of drives to check (FIXED, CDROM, REMOTE or REMOVABLE)

checkeventlog Copied

Returns EventLog events over the last 1h
Arguments:
    Filter              Determines the type of filtering (out/in/all/new)
     filter=in would include all items matched in the defined filters 
     filter=out would exclude all items matched in the defined filters
    Filter+             Prefix to filter in (to be followed with generated or eventtype)
    Filter-             Prefix to filter out (to be followed with generated or eventtype)
     Examples:                               
       Filter+generated    Period of time to capture events in.(e.g filter+generated=<1h)
       Filter-eventtype    Type of event to filter out (e.g filter-eventtype=auditSuccess)
    File                Type of eventfile (e.g system/application/security)
    Truncate            Size of the output message (e.g 1023 chars)
    Descriptions        Deprecated
    Unique              Stops duplication of messages
    MaxCrit             Maximum number of events before Critical level
    MaxWarn             Maximum number of events before Warning level

checkmem Copied

Returns information on system memory
Arguments:
    MinWarn    Warning level for minimum of free memory available
    MaxWarn    Warning level for maximun of free memory available
    MinCrit    Critical level for minimum of free memory available 
    MaxCrit    Critical level for maximum of free memory available 
    Type       Type of memory (page/physical)
    ShowAll    Gives more verbose output

checkservicestate Copied

Returns state of specified services
Arguments:
    <service-name>=<service-state> 
        Specified service and its expected state
    <service-name>=<service-state> <service-name2>=<service-state> <service-name3>=<service-state>
        This check can take in a list of services and expected states by separating them with spaces
    State can be either started (default) or stopped
    ShowAll gives more verbose output
["Opsview On-premises"] ["User Guide"]

Was this topic helpful?