5.4.1 Set static route
Function
Specifies a static route on a Windows or Linux target server.
Use situation
In the case of a system connected to multiple LANs, you use this plugin to set a static route for communication to a specific network.
Prerequisites
For the latest support information about [Required products on the execution target server]/[OS running in the execution target server], see the release notes.
In addition, the following OS and products use abbreviations. For the abbreviations of OS and products, see the "Preface".
[Required products on the execution target server]
None.
[OS running in the execution target server]
(1) Windows Server
(2) Red Hat Enterprise Linux Server
The net-tools package must be installed.
[Usage conditions for the target server]
None.
Cautions
(1) You must specify a destination IP address, a subnet mask, and a default gateway. If any of these is omitted, the static route is not set.
Version
02.00.00
Plug-in tags
Configure OS,Windows,Linux
Plug-in name displayed in the task log
osSetStaticRoute
Return code
0: Normal
12: Error (user error) Invalid property
14: Error (user error) File access disabled
23: Error (invalid environment) Required environment is invalid
27: Error (check task logs for the nature of error)
41: Error (error detected in plugin) Missing property (error detected in plugin script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
OS.destIPAddress |
Destination IP of static route |
Specify the IP address of the destination network for which you want to set a static route. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.subnetMaskStaticRoute |
Subnet mask (static route) |
Specify the subnet mask for the static route. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.defaultGWStaticRoute |
Default gateway (static route) |
Specify the default gateway for the static route. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |