Network

Availability table

Controller availability

Module	Available
module.scripts
module.keycloak

network controller

This controller expose features of osp-network-monitoring through an object controller.

network.ping(moduleId: string, hosts: string[])

Send an ping request to multiple host.

Arguments:

• moduleId – Item ID of a module.network-monitoring module

• hosts – The list of hosts to ping. This can be either a hostname or an ip.

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

• content (object) Contains the list of the result of each ping action.

  • success (boolean) Indicates that the pings were successful.

  • message (string) Message resuming the results.

  • results (object[]) List of ping’s results

    • reachable (boolean) Flag to indicate if the ping was successful.

    • host (string) The host that was pinged.

    • message (string) Message resuming the result.

network.ping(moduleId: string, host: string)

Send an ping request.

Arguments:

• moduleId – Item ID of a module.network-monitoring module

• host – The host to ping. This can be either a hostname or an ip.

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

• content (object) Contains the result of the ping action.

  • reachable (boolean) Flag to indicate if the ping was successful.

  • host (string) The host that was pinged.

  • message (string) Message resuming the result.