From 897616aae05cef5f573fdab41f083a2c46a8e9dd Mon Sep 17 00:00:00 2001
From: Frederico Sequeira <frederico.sequeira@ext.ec.europa.eu>
Date: Wed, 12 Feb 2025 16:06:41 +0000
Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=93=9D=F0=9F=94=96=20Add=20documentat?=
=?UTF-8?q?ion=20and=20Increase=20version?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/how_to_use.md | 36 ++++++++++++++++++++++++++++++++++++
pyproject.toml | 2 +-
2 files changed, 37 insertions(+), 1 deletion(-)
diff --git a/docs/how_to_use.md b/docs/how_to_use.md
index 7925d2d..d9cd5d5 100644
--- a/docs/how_to_use.md
+++ b/docs/how_to_use.md
@@ -74,3 +74,39 @@ Rules:
- The "structure_name" must be a list.
- Each field in the list must be a dictionary.
- Each field must contain `type` and `required` keys.
+
+### CreateVirtualMachine API body template:
+The user can use the API endpoint CreateVirtualMachine to created a virtual machine and all the related objects just like what happens when the form is used.
+The next template can be used to help fill all the required information:
+
+```json
+{
+ "provider_type": 1,
+ "provider": 1,
+ "name": "VM Name",
+ "status": "active",
+ "owner": 1,
+ "platform": 1,
+ "description": "VM description",
+ "virtual_machine_type": 1,
+ "interface_name": "mock",
+ "ip_addresses": "192.168.1.10/24",
+ "ip_addresses_status": "active",
+ "gateway": "193.168.1.10/24",
+ "gateway_status": "active",
+ "domain_names": {"example_domain_name": "vm.example.com"},
+ "extra_config_structure": 1,
+ "extra_config_values": {"vpc_id": "string","ssh_key": "string","assign_public_ip": "true","security_group_id": "string"},
+ "ntp_service_name": "ntp server",
+ "ntp_service_protocol": "tcp",
+ "ntp_service_ports": "33",
+ "dns_service_name": "dns server",
+ "dns_service_protocol": "tcp",
+ "dns_service_ports": "44",
+ "syslog_service_name": "syslog server",
+ "syslog_service_protocol": "tcp",
+ "syslog_service_ports": "33",
+ "tag":1
+}
+```
+When an integer is mentioned, for example, `"provider_type": 1`, the value should the the id of the object that it correponds to that information. In this example it's the ID of the `cluster type`. The values in the template are just examples.
\ No newline at end of file
diff --git a/pyproject.toml b/pyproject.toml
index b6a3d01..71c6eb6 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
[tool.poetry]
name = "netbox-sys-plugin"
-version = "1.1.1"
+version = "1.2.0"
authors = ["Frederico Sequeira", "Magdalena Gomez", "Vincent Simonin",]
maintainers = []
--
GitLab
From 8401a40bf6f612a6f4871b02db317a4e4dfc2b29 Mon Sep 17 00:00:00 2001
From: Frederico Sequeira <frederico.sequeira@ext.ec.europa.eu>
Date: Wed, 12 Feb 2025 16:28:49 +0000
Subject: [PATCH 2/2] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20Fix=20typos?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/how_to_use.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/how_to_use.md b/docs/how_to_use.md
index d9cd5d5..1b31329 100644
--- a/docs/how_to_use.md
+++ b/docs/how_to_use.md
@@ -76,7 +76,7 @@ Rules:
- Each field must contain `type` and `required` keys.
### CreateVirtualMachine API body template:
-The user can use the API endpoint CreateVirtualMachine to created a virtual machine and all the related objects just like what happens when the form is used.
+The user can use the API endpoint CreateVirtualMachine to create a virtual machine and all the related objects just like what happens when the form is used.
The next template can be used to help fill all the required information:
```json
@@ -109,4 +109,4 @@ The next template can be used to help fill all the required information:
"tag":1
}
```
-When an integer is mentioned, for example, `"provider_type": 1`, the value should the the id of the object that it correponds to that information. In this example it's the ID of the `cluster type`. The values in the template are just examples.
\ No newline at end of file
+When an integer is mentioned, for example, `"provider_type": 1`, the value should be the ID of the object that corresponds to that information. In this example, it's the ID of the `cluster type`. The values in the template are just examples.
\ No newline at end of file
--
GitLab