Skip to content

lock.md

Latest commit

 

History

History
87 lines (68 loc) · 3.63 KB

lock.md

File metadata and controls

87 lines (68 loc) · 3.63 KB

lock

Create and delete Linode resource locks.

Resource locks protect resources from accidental deletion.

Locks can only be created and deleted by unrestricted users.

NOTE: Locks cannot be updated. To change a lock, delete it and create a new one.

Minimum Required Fields

Field Type Required Description
api_token str Required The Linode account personal access token. It is necessary to run the module.
It can be exposed by the environment variable LINODE_API_TOKEN instead.
See details in Usage.

Examples

- name: Create a lock on a Linode instance
  linode.cloud.lock:
    entity_type: linode
    entity_id: 12345
    lock_type: cannot_delete
    state: present
- name: Create a lock with subresource protection
  linode.cloud.lock:
    entity_type: linode
    entity_id: 12345
    lock_type: cannot_delete_with_subresources
    state: present
- name: Create a lock on a NodeBalancer
  linode.cloud.lock:
    entity_type: nodebalancer
    entity_id: 12345
    lock_type: cannot_delete
    state: present
- name: Delete a lock by ID
  linode.cloud.lock:
    id: 67890
    state: absent

Parameters

Field Type Required Description
state str Required The state of the lock. (Choices: present, absent)
id int Optional The ID of the lock to delete. Only used when state is absent; ignored when state is present.
entity_type str Optional The type of entity to lock. Supported entity types: 'linode', 'volume', 'nodebalancer', 'lkecluster', 'lkenodepool'. (Choices: linode, volume, nodebalancer, lkecluster, lkenodepool)
entity_id int Optional The ID of the entity to lock.
lock_type str Optional The type of lock to apply. Only one delete-protection lock may exist per resource at a time. 'cannot_delete' - Prevents deletion of the entity. 'cannot_delete_with_subresources' - Prevents deletion of the entity and its subresources (disks, configs, etc.). (Choices: cannot_delete, cannot_delete_with_subresources)

Return Values

  • lock - The lock in JSON serialized form.

    • Sample Response: 
      {
    "id": 1,
    "lock_type": "cannot_delete",
    "entity": {
        "id": 6003234,
        "type": "linode",
        "label": "my-linode",
        "url": "/v4/linode/instances/6003234"
    }
}
    • See the Linode API response documentation for a list of returned fields