netbox_journal_entry_module.rst

orphan

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 <ansible_collections.netbox.netbox.netbox_journal_entry_module_requirements> for details.

To use it in a playbook, specify: netbox.netbox.netbox_journal_entry.

ansible-version-added

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

ansible-option-table

Parameter	Comments
ansible-option-title cert ansible-option-type-line any	Certificate path
ansible-option-title data ansible-option-type-line dictionary / required	Defines the journal entry
ansible-option-title assigned_object_id ansible-option-type-line integer / required	ID of the object to create the journal entry on
ansible-option-title assigned_object_type ansible-option-type-line string / required	The object type of the model
ansible-option-title comments ansible-option-type-line string / required	The comment associated with the journal entry
ansible-option-title created_by ansible-option-type-line integer	The user ID of the user creating the journal entry. Omit to use the API token user
ansible-option-title custom_fields ansible-option-type-line dictionary	Must exist in NetBox
ansible-option-title kind ansible-option-type-line string	The kind of journal entry
ansible-option-title tags ansible-option-type-line list / elements=any	Any tags that the journal entry may need to be associated with
ansible-option-title netbox_token ansible-option-type-line string / required	The NetBox API token.
ansible-option-title netbox_url ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
ansible-option-title query_params ansible-option-type-line list / elements=string	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.
ansible-option-title state ansible-option-type-line string	Use new for adding a journal entry. ansible-option-line Choices: "new" ← (default)
ansible-option-title validate_certs ansible-option-type-line any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. ansible-option-line Default: true

Notes

Note

- Tags should be defined as a YAML list - This should be ran with connection local and hosts localhost

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 <common_return_values>, the following are the fields unique to this module:

ansible-option-table

Key	Description
ansible-option-title journal_entry ansible-option-type-line dictionary	Serialized object as created or already existent within NetBox ansible-option-line Returned: on creation
ansible-option-title msg ansible-option-type-line string	Message indicating failure or info about what has been achieved ansible-option-line Returned: always

Authors

• Martin Rødvand (@rodvand)

Collection links

Issue Tracker Repository (Sources)