networktocode / networktocode.nautobot / 5.1.1 / module / circuit_termination Create, update or delete circuit terminations within Nautobot | "added in version" 1.0.0 of networktocode.nautobot" Authors: Mikhail Yohman (@FragmentedPacket)networktocode.nautobot.circuit_termination (5.1.1) — module
Install with ansible-galaxy collection install networktocode.nautobot:==5.1.1
collections: - name: networktocode.nautobot version: 5.1.1
Creates, updates or removes circuit terminations from Nautobot
- name: "Test Nautobot modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create circuit termination within Nautobot with only required information networktocode.nautobot.circuit_termination: url: http://nautobot.local token: thisIsMyToken circuit: Test Circuit term_side: A location: name: My Location parent: Parent Location port_speed: 10000 state: present - name: Create circuit termination to Provider Network networktocode.nautobot.circuit_termination: url: http://nautobot.local token: thisIsMyToken circuit: Test Circuit term_side: Z provider_network: name: "Provider A" port_speed: 10000 state: present - name: Update circuit termination with other fields networktocode.nautobot.circuit_termination: url: http://nautobot.local token: thisIsMyToken circuit: Test Circuit term_side: A upstream_speed: 1000 xconnect_id: 10X100 pp_info: PP10-24 description: "Test description" state: present - name: Delete circuit termination within nautobot networktocode.nautobot.circuit_termination: url: http://nautobot.local token: thisIsMyToken circuit: Test Circuit term_side: A state: absent
url: description: - 'The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)' required: true type: str state: choices: - absent - present default: present description: - Use C(present) or C(absent) for adding or removing. type: str token: description: - The token created within Nautobot to authorize API access required: true type: str circuit: description: - The circuit to assign to circuit termination required: true type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot pp_info: description: - Patch panel information required: false type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot location: description: - The location the circuit termination will be assigned to required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot term_side: choices: - A - Z description: - The side of the circuit termination required: true type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot port_speed: description: - The speed of the port (Kbps) required: false type: int version_added: 3.0.0 version_added_collection: networktocode.nautobot api_version: description: - API Version Nautobot REST API required: false type: str version_added: 4.1.0 version_added_collection: networktocode.nautobot description: description: - Description of the circuit termination required: false type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot xconnect_id: description: - The cross connect ID of the circuit termination required: false type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot query_params: description: - This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined - in plugins/module_utils/utils.py and provides control to users on what may make - an object unique in their environment. elements: str required: false type: list version_added: 3.0.0 version_added_collection: networktocode.nautobot upstream_speed: description: - The upstream speed of the circuit termination required: false type: int version_added: 3.0.0 version_added_collection: networktocode.nautobot validate_certs: default: true description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. required: false type: raw provider_network: description: - Connection to a provider_network type required: false type: raw version_added: 4.2.0 version_added_collection: networktocode.nautobot
circuit_termination: description: Serialized object as created or already existent within Nautobot returned: success (when I(state=present)) type: dict msg: description: Message indicating failure or info about what has been achieved returned: always type: str