netbox.netbox.netbox_journal_entry module – Creates a journal entry¶
Note
This module is part of the netbox.netbox collection (version 3.16.0).
To install it, use: ansible-galaxy collection install netbox.netbox
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netbox.netbox.netbox_journal_entry
.
New in netbox.netbox 3.12.0
Synopsis¶
Creates a journal entry in NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the journal entry |
|
ID of the object to create the journal entry on |
|
The object type of the model |
|
The comment associated with the journal entry |
|
The user ID of the user creating the journal entry. Omit to use the API token user |
|
Must exist in NetBox |
|
The kind of journal entry |
|
Any tags that the journal entry may need to be associated with |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment. |
|
Use Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: :ansible-option-default:`true` |
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples¶
- name: "Test NetBox Module"
hosts: localhost
connection: local
gather_facts: false
module_defaults:
group/netbox.netbox.netbox:
netbox_url: MYURL
netbox_token: MYTOKEN
tasks:
- name: Create an IP Address
netbox.netbox.netbox_ip_address:
data:
address: 192.168.8.14/24
register: ip
- name: Create a journal entry
netbox.netbox.netbox_journal_entry:
data:
assigned_object_type: ipam.ipaddress
assigned_object_id: "{{ ip.ip_address.id }}"
kind: success
comments: |
This is a journal entry
when: ip.changed
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Serialized object as created or already existent within NetBox Returned: on creation |
|
Message indicating failure or info about what has been achieved Returned: always |