4.16.10 Configure Windows firewall
Function
Registers a specified program or port as a Windows firewall exception.
This plugin assumes the following server:
• Execution target server
This is the server for which the Windows firewall exception is registered.
Execute the plugin with one of the following property groups specified, depending on the target that you want to register:
To register a program, specify the OS.programPathName and OS.programName properties.
To register a port, specify the OS.protocol, OS.portNumber, and OS.portName properties.
If the specified program or port has already been registered, the plugin outputs an information message to the task log and then skips the registration processing.
Use situation
After you have installed an application, you use this plugin to set a firewall setting so that the application will run normally.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target server]/[OS running in the execution target server], see the release notes.
[Required product in the System]
JP1/Automatic Operation 11-00 or later
[Required products on the execution target server]
None.
[OS running in the execution target server]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
[Usage conditions for required products on the execution target server]
(1) The Windows Firewall/Internet Connection Sharing (ICS) service has started.
Version
02.00.00
Plug-in tags
Configure OS,Windows
Plug-in name displayed in the task log
osSetFirewallDef
Return code
0: Normal
21: Error (invalid environment) Command cannot be found (error detected in the plugin script)
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.programPathName |
Program path |
Specify the full path names of the program files to be added to the Windows Firewall exceptions list (this is required to add programs to the exceptions list). |
-- |
Input |
O |
|
OS.programName |
Program name |
Specify the names of the programs to be added to the Windows Firewall exceptions list (this is required to add programs to the exceptions list). |
-- |
Input |
O |
|
OS.protocol |
Protocol |
Specify TCP, UDP, or ALL as the protocol used for the ports to be added to the Windows Firewall exceptions list (this is required to add ports to the exceptions list). |
-- |
Input |
O |
|
OS.portNumber |
Port number |
Specify the port numbers to be added to the Windows Firewall exceptions list (this is required to add ports to the exceptions list). |
-- |
Input |
O |
|
OS.portName |
Port name |
Specify the port names to be added to the Windows Firewall exceptions list (this is required to add ports to the exceptions list). |
-- |
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 |