Parameter |
Choices/Defaults |
Comments |
auto_publish_session
boolean
|
|
Publish the current session if changes have been performed after task completes.
|
color
string
|
Choices:
- aquamarine
- black
- blue
- crete blue
- burlywood
- cyan
- dark green
- khaki
- orchid
- dark orange
- dark sea green
- pink
- turquoise
- dark blue
- firebrick
- brown
- forest green
- gold
- dark gold
- gray
- dark gray
- light green
- lemon chiffon
- coral
- sea green
- sky blue
- magenta
- purple
- slate blue
- violet red
- navy blue
- olive
- orange
- red
- sienna
- yellow
|
Color of the object. Should be one of existing colors.
|
comments
string
|
|
Comments string.
|
details_level
string
|
Choices:
- uid
- standard
- full
|
The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.
|
groups
list
/ elements=string
|
|
Collection of group identifiers.
|
host_servers
dictionary
|
|
Servers Configuration.
|
|
dns_server
boolean
|
|
Gets True if this server is a DNS Server.
|
|
mail_server
boolean
|
|
Gets True if this server is a Mail Server.
|
|
web_server
boolean
|
|
Gets True if this server is a Web Server.
|
|
web_server_config
dictionary
|
|
Web Server configuration.
|
|
|
additional_ports
list
/ elements=string
|
|
Server additional ports.
|
|
|
application_engines
list
/ elements=string
|
|
Application engines of this web server.
|
|
|
listen_standard_port
boolean
|
|
Whether server listens to standard port.
|
|
|
operating_system
string
|
Choices:
- sparc linux
- windows
- other
- x86 linux
- sparc solaris
|
Operating System.
|
|
|
protected_by
string
|
|
Network object which protects this server identified by the name or UID.
|
ignore_errors
boolean
|
|
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
|
ignore_warnings
boolean
|
|
Apply changes ignoring warnings.
|
interfaces
list
/ elements=string
|
|
Host interfaces.
|
|
color
string
|
Choices:
- aquamarine
- black
- blue
- crete blue
- burlywood
- cyan
- dark green
- khaki
- orchid
- dark orange
- dark sea green
- pink
- turquoise
- dark blue
- firebrick
- brown
- forest green
- gold
- dark gold
- gray
- dark gray
- light green
- lemon chiffon
- coral
- sea green
- sky blue
- magenta
- purple
- slate blue
- violet red
- navy blue
- olive
- orange
- red
- sienna
- yellow
|
Color of the object. Should be one of existing colors.
|
|
comments
string
|
|
Comments string.
|
|
details_level
string
|
Choices:
- uid
- standard
- full
|
The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.
|
|
ignore_errors
boolean
|
|
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
|
|
ignore_warnings
boolean
|
|
Apply changes ignoring warnings.
|
|
mask_length
integer
|
|
IPv4 or IPv6 network mask length. If both masks are required use mask-length4 and mask-length6 fields explicitly. Instead of IPv4 mask length it is possible to specify IPv4 mask itself in subnet-mask field.
|
|
mask_length4
integer
|
|
IPv4 network mask length.
|
|
mask_length6
integer
|
|
IPv6 network mask length.
|
|
name
string
|
|
Interface name.
|
|
subnet
string
|
|
IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly.
|
|
subnet4
string
|
|
IPv4 network address.
|
|
subnet6
string
|
|
IPv6 network address.
|
|
subnet_mask
string
|
|
IPv4 network mask.
|
ip_address
string
|
|
IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.
|
ipv4_address
string
|
|
IPv4 address.
|
ipv6_address
string
|
|
IPv6 address.
|
name
string
/ required
|
|
Object name.
|
nat_settings
dictionary
|
|
NAT settings.
|
|
auto_rule
boolean
|
|
Whether to add automatic address translation rules.
|
|
hide_behind
string
|
Choices:
- gateway
- ip-address
|
Hide behind method. This parameter is not required in case "method" parameter is "static".
|
|
install_on
string
|
|
Which gateway should apply the NAT translation.
|
|
ip_address
string
|
|
IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly. This parameter is not required in case "method" parameter is "hide" and "hide-behind" parameter is "gateway".
|
|
ipv4_address
string
|
|
IPv4 address.
|
|
ipv6_address
string
|
|
IPv6 address.
|
|
method
string
|
|
NAT translation method.
|
state
string
|
Choices:
present ←
- absent
|
State of the access rule (present or absent). Defaults to present.
|
tags
list
/ elements=string
|
|
Collection of tag identifiers.
|
version
string
|
|
Version of checkpoint. If not given one, the latest version taken.
|
wait_for_task
boolean
|
|
Wait for the task to end. Such as publish task.
|
wait_for_task_timeout
integer
|
Default:
30
|
How many minutes to wait until throwing a timeout error.
|