cisco.sccfm.edit_object_override

Back to Ansible Reference

$ ansible-doc -t module cisco.sccfm.edit_object_override

> MODULE cisco.sccfm.edit_object_override (sccfm-ansible/plugins/modules/edit_object_override.py)

  Edit the value of an existing device-specific override on an object.
  The override must already exist for the given target device. Use
  [cisco.sccfm.add_object_override] to create a new one.
  All other overrides and the `defaultContent' are preserved.
  Supports `NETWORK_OBJECT' and `URL_OBJECT' types.

OPTIONS (= indicates it is required):

- api_token  API token for SCCFM.
        set_via:
          env:
          - name: SCCFM_API_TOKEN
        default: null
        no_log: true
        type: str

= override_value  The new value for the override. For network objects
                   this can be an IP address (e.g., `10.0.0.1'), a
                   CIDR subnet (e.g., `10.0.0.0/24'), or an IP range.
                   For URL objects this should be the URL string.
        type: str

- region  SCCFM region (int, us, eu, apj, au, uae, in, or ci).
        set_via:
          env:
          - name: SCCFM_REGION
        default: null
        type: str

= target_id  UID of the target device whose override value to edit.
        type: str

= uid     Unique identifier (UID) of the object to edit.
        type: str

AUTHOR: Cisco SCCFM Team

EXAMPLES:
# Example 1: Edit an existing override for a specific device
- name: Update override value for branch office device
  cisco.sccfm.edit_object_override:
    uid: "abc-123-def"
    target_id: "70bde3c9-328c-4a4b-bdc9-a4d4042bf09a"
    override_value: "10.20.30.40"
    region: "{{ sccfm_region }}"
    api_token: "{{ sccfm_api_token }}"

# Example 2: Using module_defaults
- name: Edit object overrides
  hosts: localhost
  gather_facts: false
  module_defaults:
    group/cisco.sccfm.all:
      region: "{{ sccfm_region }}"
      api_token: "{{ lookup('env', 'SCCFM_API_TOKEN') }}"
  tasks:
    - name: Edit override
      cisco.sccfm.edit_object_override:
        uid: "{{ object_uid }}"
        target_id: "{{ device_uid }}"
        override_value: "{{ new_ip }}"
      register: edit_result

    - name: Show result
      ansible.builtin.debug:
        var: edit_result.object_override

RETURN VALUES:

- object_override  The updated object state after the override was
                    edited.
        returned: success
        type: dict
        contains:

        - name  Name of the object.
          type: str

        - object_type  Type of the object (e.g., NETWORK_OBJECT,
                        URL_OBJECT).
          type: str

        - overrides_count  Total number of overrides on the object.
          type: int

        - uid  Unique identifier of the object.
          type: str