panos_address_object – Create address objects on PAN-OS devices¶
New in version 2.8.
Requirements¶
The below requirements are needed on the host that executes this module.
pan-python can be obtained from PyPI https://pypi.python.org/pypi/pan-python
pandevice can be obtained from PyPI https://pypi.python.org/pypi/pandevice
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
address_type
-
|
|
Type of address object.
|
|
api_key
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The API key to use instead of generating it using username / password.
|
||
commit
boolean
|
|
Commit changes after creating object. If ip_address is a Panorama device, and device_group is also set, perform a commit to Panorama and a commit-all to the device group.
|
|
description
-
|
Descriptive name for this address object.
|
||
device_group
string
|
Default: shared
|
(Panorama only) The device group the operation should target.
|
|
ip_address
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The IP address or hostname of the PAN-OS device being configured.
|
||
name
-
/ required
|
Name of object to create.
|
||
password
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The password to use for authentication. This is ignored if api_key is specified.
|
||
port
integer
|
Default: 443
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The port number to connect to the PAN-OS device on.
|
|
provider
-
added in 2.8 |
A dict object containing connection details.
|
||
api_key
string
|
The API key to use instead of generating it using username / password.
|
||
ip_address
string
|
The IP address or hostname of the PAN-OS device being configured.
|
||
password
string
|
The password to use for authentication. This is ignored if api_key is specified.
|
||
port
integer
|
Default: 443
|
The port number to connect to the PAN-OS device on.
|
|
serial_number
string
|
The serial number of a firewall to use for targeted commands. If ip_address is not a Panorama PAN-OS device, then this param is ignored.
|
||
username
string
|
Default: admin
|
The username to use for authentication. This is ignored if api_key is specified.
|
|
state
string
|
|
The state.
|
|
tag
list
|
List of tags to add to this address object.
|
||
username
string
|
Default: admin
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The username to use for authentication. This is ignored if api_key is specified.
|
|
value
-
/ required
|
IP address, IP range, or FQDN for the object. Must specify if state is present.
|
||
vsys
string
|
Default: vsys1
|
The vsys this object belongs to.
|
Notes¶
Note
Panorama is supported.
Check mode is supported.
PAN-OS connectivity should be specified using provider or the classic PAN-OS connectivity params (ip_address, username, password, api_key, and port). If both are present, then the classic params are ignored.
Examples¶
- name: Create object 'Test-One'
panos_address_object:
provider: '{{ provider }}'
name: 'Test-One'
value: '1.1.1.1'
description: 'Description One'
tag: ['Prod']
- name: Create object 'Test-Two'
panos_address_object:
provider: '{{ provider }}'
name: 'Test-Two'
address_type: 'ip-range'
value: '1.1.1.1-2.2.2.2'
description: 'Description Two'
tag: ['SI']
- name: Create object 'Test-Three'
panos_address_object:
provider: '{{ provider }}'
name: 'Test-Three'
address_type: 'fqdn'
value: 'foo.bar.baz'
description: 'Description Three'
- name: Delete object 'Test-Two'
panos_address_object:
provider: '{{ provider }}'
name: 'Test-Two'
state: 'absent'
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community.
Authors¶
Michael Richardson (@mrichardson03)