Skip to content

Commit 75a3e68

Browse files
committed
update to docs seciton
1 parent 2d807e5 commit 75a3e68

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

plugins/modules/netbox_tunnel.py

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,34 +9,34 @@
99

1010
DOCUMENTATION = r"""
1111
---
12-
module: netbox_location
13-
short_description: Create, update or delete locations within NetBox
12+
module: netbox_tunnel
13+
short_description: Create, update or delete tunnels within NetBox
1414
description:
15-
- Creates, updates or removes locations from NetBox
15+
- Creates, updates or removes tunnels from NetBox
1616
notes:
1717
- Tags should be defined as a YAML list
1818
- This should be ran with connection C(local) and hosts C(localhost)
1919
author:
20-
- Andrew Simmons (@andybro19)
20+
- Rich Bibby (@richbibby)
2121
requirements:
2222
- pynetbox
23-
version_added: '3.3.0'
23+
version_added: '3.20.0'
2424
extends_documentation_fragment:
2525
- netbox.netbox.common
2626
options:
2727
data:
2828
type: dict
2929
description:
30-
- Defines the location configuration
30+
- Defines the tunnel configuration
3131
suboptions:
3232
name:
3333
description:
34-
- The name of the location
34+
- The name of the tunnel
3535
required: true
3636
type: str
3737
status:
3838
description:
39-
- Status of the location
39+
- Status of the tunnel
4040
required: false
4141
type: raw
4242
version_added: "3.20.0"
@@ -48,17 +48,17 @@
4848
type: str
4949
site:
5050
description:
51-
- Required if I(state=present) and the location does not exist yet
51+
- Required if I(state=present) and the tunnel does not exist yet
5252
required: false
5353
type: raw
54-
parent_location:
54+
parent_tunnel:
5555
description:
56-
- The parent location the location will be associated with
56+
- The parent tunnel the tunnel will be associated with
5757
required: false
5858
type: raw
5959
tenant:
6060
description:
61-
- The tenant that the location will be associated with
61+
- The tenant that the tunnel will be associated with
6262
required: false
6363
type: raw
6464
version_added: "3.8.0"
@@ -70,7 +70,7 @@
7070
version_added: "3.20.0"
7171
description:
7272
description:
73-
- The description of the location
73+
- The description of the tunnel
7474
required: false
7575
type: str
7676
tags:
@@ -96,38 +96,38 @@
9696
gather_facts: false
9797
9898
tasks:
99-
- name: Create location within NetBox with only required information
100-
netbox.netbox.netbox_location:
99+
- name: Create tunnel within NetBox with only required information
100+
netbox.netbox.netbox_tunnel:
101101
netbox_url: http://netbox.local
102102
netbox_token: thisIsMyToken
103103
data:
104-
name: Test location
104+
name: Test tunnel
105105
site: Test Site
106106
state: present
107107
108-
- name: Create location within NetBox with a parent location, status and facility
109-
netbox.netbox.netbox_location:
108+
- name: Create tunnel within NetBox with a parent tunnel, status and facility
109+
netbox.netbox.netbox_tunnel:
110110
netbox_url: http://netbox.local
111111
netbox_token: thisIsMyToken
112112
data:
113-
name: Child location
113+
name: Child tunnel
114114
site: Test Site
115-
parent_location: Test location
115+
parent_tunnel: Test tunnel
116116
status: planned
117117
facility: Test Facility
118118
state: present
119119
120-
- name: Delete location within NetBox
121-
netbox.netbox.netbox_location:
120+
- name: Delete tunnel within NetBox
121+
netbox.netbox.netbox_tunnel:
122122
netbox_url: http://netbox.local
123123
netbox_token: thisIsMyToken
124124
data:
125-
name: Test location
125+
name: Test tunnel
126126
state: absent
127127
"""
128128

129129
RETURN = r"""
130-
location:
130+
tunnel:
131131
description: Serialized object as created or already existent within NetBox
132132
returned: success (when I(state=present))
133133
type: dict

0 commit comments

Comments
 (0)