Added Doc for RenameNetworkAdapters (#213)

* Add RenameNetworkAdapter documentation * fixed typo * format fix * addec Changelog --------- Co-authored-by: Niko P <[email protected]>
dsccommunity · Apr 20, 2023 · c65f5a7 · c65f5a7
1 parent 0824282
commit c65f5a7
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - new resource to control state parameters of Hyper-V virtual machines
 - RenameNetworkAdapters
     - Add composite to rename network adapters
+    - Add documentation
 
 ### Changed
 

diff --git a/doc/RenameNetworkAdapter.adoc b/doc/RenameNetworkAdapter.adoc
@@ -0,0 +1,58 @@
+// CommonTasks YAML Reference: RenameNetworkAdapters
+// ==================================================
+
+:YmlCategory: RenameNetworkAdapters
+
+:abstract:    {YmlCategory} renames network adapters.
+
+[#dscyml_RenameNetworkAdapters]
+= DSC Resource '{YmlCategory}'
+
+[[dscyml_RenameNetworkAdapters_abstract, {abstract}]]
+{abstract}
+
+
+[cols="1,3a" options="autowidth" caption=]
+|===
+| Source         | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/RenameNetworkAdapters
+| DSC Resource   | https://github.com/dsccommunity/NetworkingDsc[NetworkingDsc]
+| Documentation  | https://github.com/dsccommunity/NetworkingDsc/wiki/NetAdapterName[NetAdapterName]
+
+|===
+
+
+.Attributes of category '{YmlCategory}'
+[cols="1,1,1,2a,1a" options="header"]
+|===
+| Parameter
+| Attribute
+| DataType
+| Description
+| Allowed Values
+
+| Name
+|
+| String
+| Old name of the network adapter
+|
+
+| NewName
+|
+| String
+| New name of the network adapter
+|
+
+|===
+
+.Example
+[source, yaml]
+----
+RenameNetworkAdapters:
+  Adapters:
+  - Name: OldDeviceName
+    NewName: en-0
+  - Name: MacAddress
+    NewName: en-1
+  - Name: InterfaceIndex
+    NewName: en-2
+----