mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2024-05-11 05:55:12 +00:00
NEW FEATURE: Support DNS LOC record type (#2174)
This commit is contained in:
68
documentation/functions/record/LOC_BUILDER_DD.md
Normal file
68
documentation/functions/record/LOC_BUILDER_DD.md
Normal file
@ -0,0 +1,68 @@
|
||||
---
|
||||
name: LOC_BUILDER_DD
|
||||
parameters:
|
||||
- subdomain
|
||||
- decimal_degrees_x
|
||||
- decimal_degrees_y
|
||||
- altitude
|
||||
- ttl
|
||||
parameter_types:
|
||||
subdomain: string
|
||||
decimal_degrees_x: float32
|
||||
decimal_degrees_y: float32
|
||||
altitude: float32
|
||||
ttl: int
|
||||
---
|
||||
|
||||
`LOC_BUILDER_DD({})` actually takes an object with the mentioned properties.
|
||||
|
||||
A helper to build [`LOC`](../domain/LOC.md) records. Supply four parameters instead of 12.
|
||||
|
||||
Internally assumes some defaults for [`LOC`](../domain/LOC.md) records.
|
||||
|
||||
|
||||
The cartesian coordinates are decimal degrees, like you typically find in e.g. Google Maps.
|
||||
|
||||
Examples.
|
||||
|
||||
Big Ben:
|
||||
`51.50084265331501, -0.12462541415599787`
|
||||
|
||||
The White House:
|
||||
`38.89775977858357, -77.03655125982903`
|
||||
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com","none"
|
||||
, LOC_BUILDER_DD({
|
||||
label: "big-ben",
|
||||
x: 51.50084265331501,
|
||||
y: -0.12462541415599787,
|
||||
alt: 6,
|
||||
})
|
||||
, LOC_BUILDER_DD({
|
||||
label: "white-house",
|
||||
x: 38.89775977858357,
|
||||
y: -77.03655125982903,
|
||||
alt: 19,
|
||||
})
|
||||
, LOC_BUILDER_DD({
|
||||
label: "white-house-ttl",
|
||||
x: 38.89775977858357,
|
||||
y: -77.03655125982903,
|
||||
alt: 19,
|
||||
ttl: "5m",
|
||||
})
|
||||
);
|
||||
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
|
||||
Part of the series:
|
||||
* [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters
|
||||
* [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y
|
||||
* [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E
|
||||
* [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E
|
||||
* [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries LOC_BUILDER_DM*STR()
|
49
documentation/functions/record/LOC_BUILDER_DMM_STR.md
Normal file
49
documentation/functions/record/LOC_BUILDER_DMM_STR.md
Normal file
@ -0,0 +1,49 @@
|
||||
---
|
||||
name: LOC_BUILDER_DMM
|
||||
parameters:
|
||||
- subdomain
|
||||
- input_string
|
||||
- altitude
|
||||
- ttl
|
||||
parameter_types:
|
||||
subdomain: string
|
||||
input_string: string
|
||||
altitude: float32
|
||||
ttl: int
|
||||
---
|
||||
|
||||
`LOC_BUILDER_DMM({})` actually takes an object with the mentioned properties.
|
||||
|
||||
A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
||||
|
||||
Internally assumes some defaults for [`LOC`](../domain/LOC.md) records.
|
||||
|
||||
|
||||
Accepts a string with decimal minutes (DMM) coordinates in the form: 25.24°S 153.15°E
|
||||
|
||||
Note that the following are acceptable forms (symbols differ):
|
||||
* `25.24°S 153.15°E`
|
||||
* `25.24 S 153.15 E`
|
||||
* `25.24° S 153.15° E`
|
||||
* `25.24S 153.15E`
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com","none"
|
||||
LOC_BUILDER_STR({
|
||||
label: "tasmania",
|
||||
str: '42°S 147°E',
|
||||
alt: 3,
|
||||
})
|
||||
);
|
||||
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
|
||||
Part of the series:
|
||||
* [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters
|
||||
* [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y
|
||||
* [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E
|
||||
* [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E
|
||||
* [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries LOC_BUILDER_DM*STR()
|
50
documentation/functions/record/LOC_BUILDER_DMS_STR.md
Normal file
50
documentation/functions/record/LOC_BUILDER_DMS_STR.md
Normal file
@ -0,0 +1,50 @@
|
||||
---
|
||||
name: LOC_BUILDER_DMS_STR
|
||||
parameters:
|
||||
- subdomain
|
||||
- input_string
|
||||
- altitude
|
||||
- ttl
|
||||
parameter_types:
|
||||
subdomain: string
|
||||
input_string: string
|
||||
altitude: float32
|
||||
ttl: int
|
||||
---
|
||||
|
||||
`LOC_BUILDER_DMS_STR({})` actually takes an object with the mentioned properties.
|
||||
|
||||
A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
||||
|
||||
Internally assumes some defaults for [`LOC`](../domain/LOC.md) records.
|
||||
|
||||
|
||||
Accepts a string with degrees, minutes, and seconds (DMS) coordinates in the form: 41°24'12.2"N 2°10'26.5"E
|
||||
|
||||
Note that the following are acceptable forms (symbols differ):
|
||||
* `33°51′31″S 151°12′51″E`
|
||||
* `33°51'31"S 151°12'51"E`
|
||||
* `33d51m31sS 151d12m51sE`
|
||||
* `33d51m31s S 151d12m51s E`
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com","none"
|
||||
LOC_BUILDER_DMS_STR({
|
||||
label: "sydney-opera-house",
|
||||
str: '33°51′31″S 151°12′51″E',
|
||||
alt: 4,
|
||||
ttl: "5m",
|
||||
})
|
||||
);
|
||||
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
|
||||
Part of the series:
|
||||
* [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters
|
||||
* [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y
|
||||
* [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E
|
||||
* [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E
|
||||
* [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries LOC_BUILDER_DM*STR()
|
57
documentation/functions/record/LOC_BUILDER_STRING.md
Normal file
57
documentation/functions/record/LOC_BUILDER_STRING.md
Normal file
@ -0,0 +1,57 @@
|
||||
---
|
||||
name: LOC_BUILDER_STR
|
||||
parameters:
|
||||
- subdomain
|
||||
- input_string
|
||||
- altitude
|
||||
- ttl
|
||||
parameter_types:
|
||||
subdomain: string
|
||||
input_string: string
|
||||
altitude: float32
|
||||
ttl: int
|
||||
---
|
||||
|
||||
`LOC_BUILDER_STR({})` actually takes an object with the mentioned properties.
|
||||
|
||||
A helper to build [`LOC`](../domain/LOC.md) records. Supply three parameters instead of 12.
|
||||
|
||||
Internally assumes some defaults for [`LOC`](../domain/LOC.md) records.
|
||||
|
||||
|
||||
Accepts a string and tries all `LOC_BUILDER_DM*_STR({})` methods:
|
||||
* [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E
|
||||
* [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E
|
||||
|
||||
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
D("example.com","none"
|
||||
, LOC_BUILDER_STR({
|
||||
label: "old-faithful",
|
||||
str: '44.46046°N 110.82815°W',
|
||||
alt: 2240,
|
||||
})
|
||||
, LOC_BUILDER_STR({
|
||||
label: "ribblehead-viaduct",
|
||||
str: '54.210436°N 2.370231°W',
|
||||
alt: 300,
|
||||
})
|
||||
, LOC_BUILDER_STR({
|
||||
label: "guinness-brewery",
|
||||
str: '53°20′40″N 6°17′20″W',
|
||||
alt: 300,
|
||||
})
|
||||
);
|
||||
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
|
||||
Part of the series:
|
||||
* [`LOC()`](LOC.md) - build a `LOC` by supplying all 12 parameters
|
||||
* [`LOC_BUILDER_DD({})`](../record/LOC_BUILDER_DD.md) - accepts cartesian x, y
|
||||
* [`LOC_BUILDER_DMS_STR({})`](LOC_BUILDER_DMS_STR.md) - accepts DMS 33°51′31″S 151°12′51″E
|
||||
* [`LOC_BUILDER_DMM_STR({})`](LOC_BUILDER_DMM_STR.md) - accepts DMM 25.24°S 153.15°E
|
||||
* [`LOC_BUILDER_STR({})`](LOC_BUILDER_STR.md) - tries LOC_BUILDER_DM*STR()
|
Reference in New Issue
Block a user