2022-10-07 16:06:39 +00:00

118 lines
2.4 KiB
YAML

## Possible Choices:
## type:
## - text
## - integer
## - boolean
## - date
## - url
## - select
## - multiselect
## - object
## - multiobject
## filter_logic:
## - disabled
## - loose
## - exact
##
## Examples:
text_field:
type: text
label: Custom Text
description: Enter text in a text field.
required: false
weight: 0
on_objects:
- dcim.models.Device
- dcim.models.Rack
- dcim.models.Site
- dcim.models.DeviceType
- ipam.models.IPAddress
- ipam.models.Prefix
- tenancy.models.Tenant
- virtualization.models.VirtualMachine
integer_field:
type: integer
label: Custom Number
description: Enter numbers into an integer field.
required: true
filter_logic: loose
validation_minimum: 0
validation_maximum: 255
weight: 10
on_objects:
- tenancy.models.Tenant
select_field:
type: select
label: Choose between items
required: false
filter_logic: exact
weight: 30
default: First Item
on_objects:
- dcim.models.Device
choices:
- First Item
- Second Item
- Third Item
- Fifth Item
- Fourth Item
select_field_legacy_format:
type: select
label: Choose between items
required: false
filter_logic: loose
weight: 30
on_objects:
- dcim.models.Device
choices:
- value: A # this is the deprecated format.
- value: B # we only use it for the tests.
- value: C # please see above for the new format.
- value: "D like deprecated"
weight: 999
- value: E
boolean_field:
type: boolean
label: Yes Or No?
required: true
filter_logic: loose
default: "false" # important: put "false" in quotes!
weight: 90
on_objects:
- dcim.models.Device
url_field:
type: url
label: Hyperlink
description: Link to something nice.
required: true
filter_logic: disabled
validation_regex: ^https://
on_objects:
- tenancy.models.Tenant
date_field:
type: date
label: Important Date
required: false
filter_logic: disabled
on_objects:
- dcim.models.Device
multiobject_field:
type: multiobject
label: Related Objects
description: IP addresses that belong to this location
required: true
filter_logic: loose
on_objects:
- dcim.models.Location
object_type: ipam.models.IPAddress
object_field:
type: object
label: ASN
description: This device has an ASN now
required: false
filter_logic: loose
on_objects:
- dcim.models.Device
object_type: ipam.models.ASN