nautobot_ssot_ipfabric.jobs

IP Fabric Data Target Job.

Module Contents

Classes

OptionalObjectVar	Custom implementation of an Optional ObjectVar.
IpFabricDataSource	Job syncing data from IP Fabric to Nautobot.

Functions

is_valid_uuid(identifier)	Return true if the identifier it's a valid UUID.
get_formatted_snapshots(client)	Get all loaded snapshots and format them for display in choice menu.

Attributes

CONFIG
IPFABRIC_HOST
IPFABRIC_API_TOKEN
IPFABRIC_SSL_VERIFY
IPFABRIC_TIMEOUT
LAST
PREV
LAST_LOCKED
name
jobs

nautobot_ssot_ipfabric.jobs.CONFIG

nautobot_ssot_ipfabric.jobs.IPFABRIC_HOST

nautobot_ssot_ipfabric.jobs.IPFABRIC_API_TOKEN

nautobot_ssot_ipfabric.jobs.IPFABRIC_SSL_VERIFY

nautobot_ssot_ipfabric.jobs.IPFABRIC_TIMEOUT

nautobot_ssot_ipfabric.jobs.LAST = $last

nautobot_ssot_ipfabric.jobs.PREV = $prev

nautobot_ssot_ipfabric.jobs.LAST_LOCKED = $lastLocked

nautobot_ssot_ipfabric.jobs.name = SSoT - IPFabric

nautobot_ssot_ipfabric.jobs.is_valid_uuid(identifier)

Return true if the identifier it’s a valid UUID.

nautobot_ssot_ipfabric.jobs.get_formatted_snapshots(client: ipfabric.IPFClient)

Get all loaded snapshots and format them for display in choice menu.

Returns:

dict: Snapshot objects as dict of tuples {snapshot_ref: (description, snapshot_id)}

class nautobot_ssot_ipfabric.jobs.OptionalObjectVar(model=None, display_field='display', query_params=None, null_option=None, *args, **kwargs)

Bases: nautobot.extras.jobs.ScriptVariable

Custom implementation of an Optional ObjectVar.

An object primary key is returned and accessible in job kwargs.

form_field

class nautobot_ssot_ipfabric.jobs.IpFabricDataSource

Bases: nautobot_ssot.jobs.base.DataSource, nautobot.extras.jobs.Job

Job syncing data from IP Fabric to Nautobot.

class Meta

Metadata about this Job.

name = IPFabric ⟹ Nautobot

data_source = IP Fabric

data_source_icon

description = Sync data from IP Fabric into Nautobot.

field_order = ['debug', 'snapshot', 'safe_delete_mode', 'sync_ipfabric_tagged_only', 'dry_run']

client

snapshot

debug

safe_delete_mode

sync_ipfabric_tagged_only

site_filter

static _init_ipf_client()

classmethod _get_vars()

Extend JobDataSource._get_vars to include some variables.

This also initializes them.

classmethod data_mappings()

List describing the data mappings involved in this DataSource.

classmethod config_information()

Dictionary describing the configuration of this DataSource.

log_debug(message)

Conditionally log a debug message.

load_source_adapter()

Not used.

load_target_adapter()

Not used.

sync_data()

Sync a device data from IP Fabric into Nautobot.

nautobot_ssot_ipfabric.jobs.jobs