MIDServerFinder - Global

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 2 min. de leitura

    • The MIDServerFinder script include provides methods to find a list of MID Servers for specified IP addresses.

    Use in server scripts to get the MID Server list.

    MIDServerFinder - MIDServerFinder()

    Creates an instance of MIDServerFinder.

    Tabela 1. Parameters
    Name Type Description
    None
    Tabela 2. Returns
    Type Description
    void

    MIDServerFinder - getMIDServers()

    Gets the names of MID servers available for a given range and capability.

    Tabela 3. Parameters
    Name Type Description
    None
    Tabela 4. Returns
    Type Description
    Array An array of MID server names. If no MID servers are available, returns an empty array. 
    var msf = new MIDServerFinder();
msf.setRanges('10.10.10.1-10.10.11.254');
var msnames = msf.getMIDServers();
 
for(var i=0; i<msnames.length; i++) {
  gs.print(msnames[i]);
};

    MIDServerFinder - getMIDServersBySysId()

    Gets the sys_ids of MID servers available for a given range and capability.

    Tabela 5. Parameters
    Name Type Description
    None
    Tabela 6. Returns
    Type Description
    Array An array of MID server sys_ids. If no MID servers are available, returns an empty array. 
    var msf = new MIDServerFinder();
msf.setRanges('10.10.10.1-10.10.11.254');
var msids = msf.getMIDServersBySysId();
 
for(var i=0; i<msids.length; i++) {
  gs.print(msids[i]);
};

    MIDServerFinder - getStatusMessage()

    Gets the state of the finder operation.

    Tabela 7. Parameters
    Name Type Description
    None
    Tabela 8. Returns
    Type Description
    String The status message 
    var msf = new MIDServerFinder();
gs.print(msf.getStatusMessage());

    MIDServerFinder - setActive(Boolean flag)

    Sets whether to look for active or inactive MID servers. By default, searches are for active MID servers unless inactive is specified by this method.

    Tabela 9. Parameters
    Name Type Description
    flag Boolean If true, look for inactive MID servers. If false, do not look for inactive MID servers.
    Tabela 10. Returns
    Type Description
    void 
    var msf = new MIDServerFinder();
msf.setActive('true');

    MIDServerFinder - setCapabilities(Array capabilities)

    Sets the technologies for which to look.

    Tabela 11. Parameters
    Name Type Description
    capabilities Array Contains a list of capabilities, for example - capabilities = ["ssh","wmi","snmp",{"os_domain":"disco"},{"phase":1}];
    Tabela 12. Returns
    Type Description
    void 
    var msf = new MIDServerFinder();
msf.setRanges('10.10.10.1-10.10.11.254');
var capab = ["ssh","wmi","snmp"];
msf.setCapabilities(capab);

    MIDServerFinder - setDebug(Boolean onOrOff)

    Turns debugging on or off.

    Tabela 13. Parameters
    Name Type Description
    onOrOff Boolean True to turn on debugging; false to turn debugging off.
    Tabela 14. Returns
    Type Description
    void 
    var msf = new MIDServerFinder();
msf.setDebug('true');

    MIDServerFinder - setRanges(String ranges)

    Sets the range of IP addresses for which to look.

    Tabela 15. Parameters
    Name Type Description
    ranges String A comma-separated list in one of these formats.
    • IP addresses (10.10.10.1, 10.10.10.2)
    • IP networks (10.10.10.0/23)
    • IP ranges (10.10.10.1-10.10.11.254)
    Tabela 16. Returns
    Type Description
    void 
    var msf = new MIDServerFinder();
msf.setRanges('10.10.10.1-10.10.11.254');

    MIDServerFinder - setRangesByIPOrHostname(String ipOrHostname)

    Determines if the input is a single IP or a hostname, and passes the IP or multiple IPs to the setRanges() method.

    If the value of ipOrHostname is an IP address, it is passed into the setRanges() method. It the value is a hostname, we look up the DNS table (cmdb_ip_address_dns_name) to try resolving the hostname. The result, either an IP or multiple IPs, is then passes into the setRanges() method.

    Tabela 17. Parameters
    Name Type Description
    ipOrHostname String The IP address, IP range, or host name.
    Tabela 18. Returns
    Type Description
    void 
    var msf = new MIDServerFinder();
msf.setRangesByIPOrHostname('10.10.10.1-10.10.11.254');