minecraftchest1/dnscode
1
0
Fork 0
Code Issues 4 Pull requests Projects Releases 1 Packages 1 Activity Actions
dnscode/docs/html/classdnscode_1_1dnscode_1_1Zone.html
minecraftchest1@outlook.com 0c4162a6f9 Update docs
2025-01-27 10:21:20 -06:00

629 lines
34 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DNScode: dnscode.dnscode.Zone Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">DNScode<span id="projectnumber">&#160;0.1.9</span>
</div>
<div id="projectbrief">Simplifying DNS configuration</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('classdnscode_1_1dnscode_1_1Zone.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classdnscode_1_1dnscode_1_1Zone-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">dnscode.dnscode.Zone Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad696206776c2c68471126d950fa178d1" id="r_ad696206776c2c68471126d950fa178d1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad696206776c2c68471126d950fa178d1">__post_init__</a> (self)</td></tr>
<tr class="separator:ad696206776c2c68471126d950fa178d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31e74a07a8f0b0f95a14662d20f1df8c" id="r_a31e74a07a8f0b0f95a14662d20f1df8c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a31e74a07a8f0b0f95a14662d20f1df8c">__str__</a> (self)</td></tr>
<tr class="separator:a31e74a07a8f0b0f95a14662d20f1df8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a231de844d4fb88390d37a0be6dbc962e" id="r_a231de844d4fb88390d37a0be6dbc962e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a231de844d4fb88390d37a0be6dbc962e">new_A</a> (self, str name='@', int ttl=3600, str host='0.0.0.0')</td></tr>
<tr class="separator:a231de844d4fb88390d37a0be6dbc962e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af16862a7d8680f1eb6ab66a92105301f" id="r_af16862a7d8680f1eb6ab66a92105301f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af16862a7d8680f1eb6ab66a92105301f">new_AAAA</a> (self, str name='@', int ttl=3600, str host='fe80::42:2cff:fe29:8db1')</td></tr>
<tr class="separator:af16862a7d8680f1eb6ab66a92105301f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2718e32544f9310ce721bce73082bb97" id="r_a2718e32544f9310ce721bce73082bb97"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2718e32544f9310ce721bce73082bb97">new_CNAME</a> (self, str name='@', int ttl=3600, str host='example.com')</td></tr>
<tr class="separator:a2718e32544f9310ce721bce73082bb97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41dc247963652b15be123b329aeb1bcf" id="r_a41dc247963652b15be123b329aeb1bcf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a41dc247963652b15be123b329aeb1bcf">new_MX</a> (self, str name='@', int ttl=3600, int priority=10, str host='example.com')</td></tr>
<tr class="separator:a41dc247963652b15be123b329aeb1bcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0a178b817cb174866bb5bb33507cb98" id="r_ae0a178b817cb174866bb5bb33507cb98"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0a178b817cb174866bb5bb33507cb98">new_NS</a> (self, str name='@', int ttl=3600, str host='example.com')</td></tr>
<tr class="separator:ae0a178b817cb174866bb5bb33507cb98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a579ec534602081efd30fbcbc279bc625" id="r_a579ec534602081efd30fbcbc279bc625"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a579ec534602081efd30fbcbc279bc625">new_PTR</a> (self, str name='@', int ttl=3600, str host='example.com')</td></tr>
<tr class="separator:a579ec534602081efd30fbcbc279bc625"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabed9788e2e4be4c6b0628214492fdbe" id="r_aabed9788e2e4be4c6b0628214492fdbe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aabed9788e2e4be4c6b0628214492fdbe">new_SOA</a> (self, str mname='ns1.example.com', str rname='admin.example.com', int serial=int(time.time()), int refresh=86400, int retry=7200, int expire=15552000, int ttl=21700)</td></tr>
<tr class="separator:aabed9788e2e4be4c6b0628214492fdbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef9ec626cabe184b565418644798e7d4" id="r_aef9ec626cabe184b565418644798e7d4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aef9ec626cabe184b565418644798e7d4">new_SRV</a> (self, str name='@', int ttl=3600, str service='service', str protocol='proto', int priority=10, int weight=10, str host='example.com')</td></tr>
<tr class="separator:aef9ec626cabe184b565418644798e7d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ff7d4cb63c08a7d06fc47c341e3bba4" id="r_a6ff7d4cb63c08a7d06fc47c341e3bba4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6ff7d4cb63c08a7d06fc47c341e3bba4">new_record</a> (self, str name='@', int ttl=3600, str rtype='<a class="el" href="classdnscode_1_1dnscode_1_1A.html">A</a>', str data='0.0.0.0')</td></tr>
<tr class="separator:a6ff7d4cb63c08a7d06fc47c341e3bba4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a338bc686b7c7db2cab7827996a3f23f3" id="r_a338bc686b7c7db2cab7827996a3f23f3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a338bc686b7c7db2cab7827996a3f23f3">add</a> (self, <a class="el" href="classdnscode_1_1dnscode_1_1Record.html">Record</a> record)</td></tr>
<tr class="separator:a338bc686b7c7db2cab7827996a3f23f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfe5442ed2137a324f1c5ba676ba2043" id="r_adfe5442ed2137a324f1c5ba676ba2043"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adfe5442ed2137a324f1c5ba676ba2043">save_file</a> (self, str filepath)</td></tr>
<tr class="separator:adfe5442ed2137a324f1c5ba676ba2043"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a1e958c8be9cf4cc7c0f30bd227e15c5a" id="r_a1e958c8be9cf4cc7c0f30bd227e15c5a"><td class="memItemLeft" align="right" valign="top">str&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1e958c8be9cf4cc7c0f30bd227e15c5a">records</a> = str(record) + '\n'</td></tr>
<tr class="separator:a1e958c8be9cf4cc7c0f30bd227e15c5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a9edba14298d59d7453cc27786b57f457" id="r_a9edba14298d59d7453cc27786b57f457"><td class="memItemLeft" align="right" valign="top">str&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9edba14298d59d7453cc27786b57f457">origin</a> = 'example.com'</td></tr>
<tr class="separator:a9edba14298d59d7453cc27786b57f457"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e3137b233ce53fed0a87915be1b1fcd" id="r_a8e3137b233ce53fed0a87915be1b1fcd"><td class="memItemLeft" align="right" valign="top">list&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e3137b233ce53fed0a87915be1b1fcd">records</a> = field(default_factory=list)</td></tr>
<tr class="separator:a8e3137b233ce53fed0a87915be1b1fcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">Represents a DNS zone containing multiple records.</pre> </div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad696206776c2c68471126d950fa178d1" name="ad696206776c2c68471126d950fa178d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad696206776c2c68471126d950fa178d1">&#9670;&#160;</a></span>__post_init__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.__post_init__ </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Initializes a zone with the given origin and ensures it ends with a dot.</pre>
</div>
</div>
<a id="a31e74a07a8f0b0f95a14662d20f1df8c" name="a31e74a07a8f0b0f95a14662d20f1df8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31e74a07a8f0b0f95a14662d20f1df8c">&#9670;&#160;</a></span>__str__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.__str__ </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Returns a string representation of the zone.</pre>
</div>
</div>
<a id="a338bc686b7c7db2cab7827996a3f23f3" name="a338bc686b7c7db2cab7827996a3f23f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a338bc686b7c7db2cab7827996a3f23f3">&#9670;&#160;</a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.add </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classdnscode_1_1dnscode_1_1Record.html">Record</a></td> <td class="paramname"><span class="paramname"><em>record</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Adds a record to the zone.</pre>
</div>
</div>
<a id="a231de844d4fb88390d37a0be6dbc962e" name="a231de844d4fb88390d37a0be6dbc962e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a231de844d4fb88390d37a0be6dbc962e">&#9670;&#160;</a></span>new_A()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.new_A </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>name</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'@'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>ttl</em></span><span class="paramdefsep"> = </span><span class="paramdefval">3600</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>host</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'0.0.0.0'</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Creates and adds a new A record to the zone.</pre>
</div>
</div>
<a id="af16862a7d8680f1eb6ab66a92105301f" name="af16862a7d8680f1eb6ab66a92105301f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af16862a7d8680f1eb6ab66a92105301f">&#9670;&#160;</a></span>new_AAAA()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.new_AAAA </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>name</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'@'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>ttl</em></span><span class="paramdefsep"> = </span><span class="paramdefval">3600</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>host</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'fe80::42:2cff:fe29:8db1'</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Creates and adds a new AAAA record to the zone.</pre>
</div>
</div>
<a id="a2718e32544f9310ce721bce73082bb97" name="a2718e32544f9310ce721bce73082bb97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2718e32544f9310ce721bce73082bb97">&#9670;&#160;</a></span>new_CNAME()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.new_CNAME </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>name</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'@'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>ttl</em></span><span class="paramdefsep"> = </span><span class="paramdefval">3600</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>host</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'example.com'</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Creates and adds a new CNAME record to the zone.</pre>
</div>
</div>
<a id="a41dc247963652b15be123b329aeb1bcf" name="a41dc247963652b15be123b329aeb1bcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41dc247963652b15be123b329aeb1bcf">&#9670;&#160;</a></span>new_MX()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.new_MX </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>name</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'@'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>ttl</em></span><span class="paramdefsep"> = </span><span class="paramdefval">3600</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>priority</em></span><span class="paramdefsep"> = </span><span class="paramdefval">10</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>host</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'example.com'</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Creates and adds a new MX record to the zone.</pre>
</div>
</div>
<a id="ae0a178b817cb174866bb5bb33507cb98" name="ae0a178b817cb174866bb5bb33507cb98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0a178b817cb174866bb5bb33507cb98">&#9670;&#160;</a></span>new_NS()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.new_NS </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>name</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'@'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>ttl</em></span><span class="paramdefsep"> = </span><span class="paramdefval">3600</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>host</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'example.com'</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Creates and adds a new NS record to the zone.</pre>
</div>
</div>
<a id="a579ec534602081efd30fbcbc279bc625" name="a579ec534602081efd30fbcbc279bc625"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a579ec534602081efd30fbcbc279bc625">&#9670;&#160;</a></span>new_PTR()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.new_PTR </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>name</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'@'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>ttl</em></span><span class="paramdefsep"> = </span><span class="paramdefval">3600</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>host</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'example.com'</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Creates and adds a new PTR record to the zone.</pre>
</div>
</div>
<a id="a6ff7d4cb63c08a7d06fc47c341e3bba4" name="a6ff7d4cb63c08a7d06fc47c341e3bba4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ff7d4cb63c08a7d06fc47c341e3bba4">&#9670;&#160;</a></span>new_record()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.new_record </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>name</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'@'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>ttl</em></span><span class="paramdefsep"> = </span><span class="paramdefval">3600</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>rtype</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'<a class="el" href="classdnscode_1_1dnscode_1_1A.html">A</a>'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>data</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'0.0.0.0'</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Creates and adds a generic DNS record to the zone.</pre>
</div>
</div>
<a id="aabed9788e2e4be4c6b0628214492fdbe" name="aabed9788e2e4be4c6b0628214492fdbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabed9788e2e4be4c6b0628214492fdbe">&#9670;&#160;</a></span>new_SOA()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.new_SOA </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>mname</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'ns1.example.com'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>rname</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'admin.example.com'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>serial</em></span><span class="paramdefsep"> = </span><span class="paramdefval">int(time.time())</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>refresh</em></span><span class="paramdefsep"> = </span><span class="paramdefval">86400</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>retry</em></span><span class="paramdefsep"> = </span><span class="paramdefval">7200</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>expire</em></span><span class="paramdefsep"> = </span><span class="paramdefval">15552000</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>ttl</em></span><span class="paramdefsep"> = </span><span class="paramdefval">21700</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Creates and adds a new SOA record to the zone.</pre>
</div>
</div>
<a id="aef9ec626cabe184b565418644798e7d4" name="aef9ec626cabe184b565418644798e7d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef9ec626cabe184b565418644798e7d4">&#9670;&#160;</a></span>new_SRV()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.new_SRV </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>name</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'@'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>ttl</em></span><span class="paramdefsep"> = </span><span class="paramdefval">3600</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>service</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'service'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>protocol</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'proto'</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>priority</em></span><span class="paramdefsep"> = </span><span class="paramdefval">10</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td> <td class="paramname"><span class="paramname"><em>weight</em></span><span class="paramdefsep"> = </span><span class="paramdefval">10</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str </td> <td class="paramname"><span class="paramname"><em>host</em></span><span class="paramdefsep"> = </span><span class="paramdefval">'example.com'</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Creates and adds a new SRV record to the zone.</pre>
</div>
</div>
<a id="adfe5442ed2137a324f1c5ba676ba2043" name="adfe5442ed2137a324f1c5ba676ba2043"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfe5442ed2137a324f1c5ba676ba2043">&#9670;&#160;</a></span>save_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dnscode.dnscode.Zone.save_file </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str</td> <td class="paramname"><span class="paramname"><em>filepath</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Saves the zone records to a file.</pre>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9edba14298d59d7453cc27786b57f457" name="a9edba14298d59d7453cc27786b57f457"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9edba14298d59d7453cc27786b57f457">&#9670;&#160;</a></span>origin</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">str dnscode.dnscode.Zone.origin = 'example.com'</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8e3137b233ce53fed0a87915be1b1fcd" name="a8e3137b233ce53fed0a87915be1b1fcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e3137b233ce53fed0a87915be1b1fcd">&#9670;&#160;</a></span>records <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">list dnscode.dnscode.Zone.records = field(default_factory=list)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1e958c8be9cf4cc7c0f30bd227e15c5a" name="a1e958c8be9cf4cc7c0f30bd227e15c5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e958c8be9cf4cc7c0f30bd227e15c5a">&#9670;&#160;</a></span>records <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">str dnscode.dnscode.Zone.records = str(record) + '\n'</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/dnscode/<a class="el" href="dnscode_8py.html">dnscode.py</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacednscode.html">dnscode</a></li><li class="navelem"><a class="el" href="namespacednscode_1_1dnscode.html">dnscode</a></li><li class="navelem"><a class="el" href="classdnscode_1_1dnscode_1_1Zone.html">Zone</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink