Sync baremetal openstack with upstream
Change-Id: I125fc08e2cc4433aeaa470de48823dd4434c2030
Related-PROD: PROD-33018
diff --git a/openstack/baremetal/v1/ports/doc.go b/openstack/baremetal/v1/ports/doc.go
new file mode 100644
index 0000000..eb0579b
--- /dev/null
+++ b/openstack/baremetal/v1/ports/doc.go
@@ -0,0 +1,85 @@
+/*
+ Package ports contains the functionality to Listing, Searching, Creating, Updating,
+ and Deleting of bare metal Port resources
+
+ API reference: https://developer.openstack.org/api-ref/baremetal/#ports-ports
+
+
+Example to List Ports with Detail
+
+ ports.ListDetail(client, nil).EachPage(func(page pagination.Page) (bool, error) {
+ portList, err := ports.ExtractPorts(page)
+ if err != nil {
+ return false, err
+ }
+
+ for _, n := range portList {
+ // Do something
+ }
+
+ return true, nil
+ })
+
+Example to List Ports
+
+ listOpts := ports.ListOpts{
+ Limit: 10,
+ }
+
+ ports.List(client, listOpts).EachPage(func(page pagination.Page) (bool, error) {
+ portList, err := ports.ExtractPorts(page)
+ if err != nil {
+ return false, err
+ }
+
+ for _, n := range portList {
+ // Do something
+ }
+
+ return true, nil
+ })
+
+Example to Create a Port
+
+ createOpts := ports.CreateOpts{
+ NodeUUID: "e8920409-e07e-41bb-8cc1-72acb103e2dd",
+ Address: "00:1B:63:84:45:E6",
+ PhysicalNetwork: "my-network",
+ }
+
+ createPort, err := ports.Create(client, createOpts).Extract()
+ if err != nil {
+ panic(err)
+ }
+
+Example to Get a Port
+
+ showPort, err := ports.Get(client, "c9afd385-5d89-4ecb-9e1c-68194da6b474").Extract()
+ if err != nil {
+ panic(err)
+ }
+
+Example to Update a Port
+
+ updateOpts := ports.UpdateOpts{
+ ports.UpdateOperation{
+ Op: ReplaceOp,
+ Path: "/address",
+ Value: "22:22:22:22:22:22",
+ },
+ }
+
+ updatePort, err := ports.Update(client, "c9afd385-5d89-4ecb-9e1c-68194da6b474", updateOpts).Extract()
+ if err != nil {
+ panic(err)
+ }
+
+Example to Delete a Port
+
+ err = ports.Delete(client, "c9afd385-5d89-4ecb-9e1c-68194da6b474").ExtractErr()
+ if err != nil {
+ panic(err)
+ }
+
+*/
+package ports