$ ansible-doc -t module cisco.sccfm.delete_object_override
> MODULE cisco.sccfm.delete_object_override (sccfm-ansible/plugins/modules/delete_object_override.py)
Delete a device-specific override from an object.
The override must already exist for the given target device. Use
[cisco.sccfm.get_object] to list target IDs.
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
- 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 to delete.
type: str
= uid Unique identifier (UID) of the object.
type: str
AUTHOR: Cisco SCCFM Team
EXAMPLES:
# Example 1: Delete an override for a specific device
- name: Remove override for branch office device
cisco.sccfm.delete_object_override:
uid: "abc-123-def"
target_id: "70bde3c9-328c-4a4b-bdc9-a4d4042bf09a"
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
# Example 2: Using module_defaults
- name: Delete 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: Delete override
cisco.sccfm.delete_object_override:
uid: "{{ object_uid }}"
target_id: "{{ device_uid }}"
register: delete_result
- name: Show result
ansible.builtin.debug:
var: delete_result.object_override
RETURN VALUES:
- object_override The updated object state after the override was
deleted.
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 remaining on the
object.
type: int
- uid Unique identifier of the object.
type: str