Skip to content

Commit

Permalink
remove references to Terraform because this is not Terraform
Browse files Browse the repository at this point in the history
  • Loading branch information
ctreatma committed Sep 16, 2024
1 parent 1d4ed87 commit 0306b19
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/modules/metal_port.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# metal_port

This Terraform resource doesn't create an API resource in Equinix Metal, but rather provides finer control for [Layer 2 networking](https://deploy.equinix.com/developers/docs/metal/layer2-networking/overview/).
This module doesn't create a resource in Equinix Metal, but rather provides finer control for [Layer 2 networking](https://deploy.equinix.com/developers/docs/metal/layer2-networking/overview/).


- [Examples](#examples)
Expand Down
23 changes: 14 additions & 9 deletions plugins/modules/metal_port.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
# DOCUMENTATION, EXAMPLES, and RETURN are generated by
# ansible_specdoc. Do not edit them directly.

DOCUMENTATION = '''
DOCUMENTATION = r"""
author: Equinix DevRel Team (@equinix) <[email protected]>
description: This Terraform resource doesn't create an API resource in Equinix Metal,
but rather provides finer control for [Layer 2 networking](https://deploy.equinix.com/developers/docs/metal/layer2-networking/overview/).
description: This module doesn't create a resource in Equinix Metal, but rather provides
finer control for [Layer 2 networking](https://deploy.equinix.com/developers/docs/metal/layer2-networking/overview/).
module: metal_port
notes: []
options:
Expand All @@ -33,10 +33,15 @@
- UUID of native VLAN of the port
required: false
type: str
vlan_ids:
description:
- UUIDs of VLANs that should be assigned to the port
required: false
type: list
requirements: null
short_description: Manage a device port in Equinix Metal
'''
EXAMPLES = '''
"""
EXAMPLES = r"""
- name: Convert port to layer 2
hosts: localhost
tasks:
Expand All @@ -50,11 +55,11 @@
description: The Metal device port
returned: always
sample:
- bonded: true
bonded: true
id: 7624f0f7-75b6-4271-bc64-632b80f87de2
layer2: true
type: dict
'''
"""

from ansible.module_utils._text import to_native
from ansible_specdoc.objects import (
Expand Down Expand Up @@ -129,8 +134,8 @@
SPECDOC_META = getSpecDocMeta(
short_description='Manage a device port in Equinix Metal',
description=(
'This Terraform resource doesn\'t create an API resource '
'in Equinix Metal, but rather provides finer control for '
'This module doesn\'t create a resource in Equinix Metal, '
'but rather provides finer control for '
'[Layer 2 networking](https://deploy.equinix.com/developers/docs/metal/layer2-networking/overview/).'
),
examples=specdoc_examples,
Expand Down

0 comments on commit 0306b19

Please sign in to comment.