From af3bb5c744443c2474f3cc17bba9866a6b1ef9c7 Mon Sep 17 00:00:00 2001
From: "Hahn Axel (hahn)" <axel.hahn@iml.unibe.ch>
Date: Tue, 14 Jun 2022 07:51:46 +0200
Subject: [PATCH] update docs
---
README.md | 33 +++++++++++++++++++--------------
1 file changed, 19 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index 569ac23..2146342 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,12 @@
# Infoblox Dns Helperscripts
-Institute for Medical Education; University of Bern
+Search for hosts and aliases in host objects and names in cname objects
+in the infoblox dns api and show the result as json.
-Source: https://git-repo.iml.unibe.ch/open-source/infoblox-dns-helperscripts
+Institute for Medical Education; University of Bern
-License: GNU GPL 3.0
+📄 Source: <https://git-repo.iml.unibe.ch/open-source/infoblox-dns-helperscripts>\
+📜 License: GNU GPL 3.0
## Requirements
@@ -20,14 +22,6 @@ License: GNU GPL 3.0
## Usage
-### dns-api.sh
-
-Low level command to access the api
-
-`dns-api.sh [METHOD] URL`
-
-This script is used by dns-search.sh. Maybe you don't want to execute it directly.
-
### dns-search.sh
Search for aliases and hosts.
@@ -38,7 +32,7 @@ Search for aliases and hosts.
Search for hostnames or aliases in Infoblox API
It uses dns-api.sh and adds the return field for aliases.
-SYNTAX: dns-search.sh [name|alias] REGEX
+SYNTAX: dns-search.sh [name|alias|cname] REGEX
EXAMPLES:
@@ -56,8 +50,19 @@ The search supports regex:
dns-search.sh name "^(connector|examinator).*measured.stage"
(4)
-Lazy mode: do not add name or alias to start 2 requests to search in name and
-alias fields
+Lazy mode: do not add name or alias or cname to start 3 requests to search
+in all object types
dns-search.sh ufive
+Search for hostnames or aliases in Infoblox API
+It uses dns-api.sh and adds the return field for aliases.
+
```
+
+### dns-api.sh
+
+Low level command to access the api
+
+`dns-api.sh [METHOD] URL`
+
+This script is used by dns-search.sh. Maybe you don't want to execute it directly.
--
GitLab