Merge pull request #196 from DMTF/Fix195-SetServiceIdentification

Added 'setserviceid' option to rf_manager_config.py

Author: mraineri

docs/rf_manager_config.md

@@ -11,13 +11,13 @@ A tool to manage managers in a service.
 ```
 usage: rf_manager_config.py [-h] --user USER --password PASSWORD --rhost RHOST
                             [--manager MANAGER] [--debug]
-                            {info,reset,getnet,setnet,resettodefaults,settime,getprotocol,setprotocol}
+                            {info,reset,getnet,setnet,resettodefaults,settime,getprotocol,setprotocol,setserviceid}
                             ...
 
 A tool to manage managers in a service
 
 positional arguments:
-  {info,reset,getnet,setnet,resettodefaults,settime,getprotocol,setprotocol}
+  {info,reset,getnet,setnet,resettodefaults,settime,getprotocol,setprotocol,setserviceid}
     info                Displays information about a manager
     reset               Resets a manager
     getnet              Displays information about an Ethernet interface
@@ -26,6 +26,7 @@ positional arguments:
     settime             Sets the date-time on a manager
     getprotocol         Displays network protocol information about a manager
     setprotocol         Configures network protocol settings on a manager
+    setserviceid        Sets the service identification for a manager
 
 required arguments:
   --user USER, -u USER  The user name for authentication
@@ -342,3 +343,27 @@ Example:
 $ rf_manager_config.py -u root -p root -r https://192.168.1.100 setprotocol -prot IPMI -dis
 Configuring IPMI...
 ```
+
+### Set Service Identification
+
+Sets the service identification for a manager
+
+```
+usage: rf_manager_config.py setserviceid [-h] --id ID
+
+options:
+  -h, --help      show this help message and exit
+  --id ID, -i ID  The service identification to set
+```
+
+The tool will log into the service specified by the *rhost* argument using the credentials provided by the *user* and *password* arguments.
+It will then locate the manager specified by the *manager* argument, and applies the *id* value to the manager instance.
+
+* If *manager* is not specified, and if the service has exactly one manager, it will perform the operation on the one manager.
+
+Example:
+
+```
+$ rf_manager_config.py -u root -p root -r https://192.168.1.100 setserviceid -i 'New Identifier'
+Setting the identification to 'New Identifier'...
+```

redfish_utilities/managers.py

@@ -123,7 +123,7 @@ def get_manager(context, manager_id=None):
     return manager
 
 
-def set_manager(context, manager_id=None, date_time=None, date_time_offset=None):
+def set_manager(context, manager_id=None, date_time=None, date_time_offset=None, service_id=None):
     """
     Finds a manager matching the given identifier and sets one or more properties
 
@@ -132,6 +132,7 @@ def set_manager(context, manager_id=None, date_time=None, date_time_offset=None)
         manager_id: The manager to locate; if None, perform on the only manager
         date_time: The date-time value to set
         date_time_offset: The date-time offset value to set
+        service_id: The service identification value to set
 
     Returns:
         The response of the PATCH
@@ -146,6 +147,8 @@ def set_manager(context, manager_id=None, date_time=None, date_time_offset=None)
         payload["DateTime"] = date_time
     if date_time_offset is not None:
         payload["DateTimeLocalOffset"] = date_time_offset
+    if service_id is not None:
+        payload["ServiceIdentification"] = service_id
 
     # Update the manager
     headers = None
@@ -181,6 +184,7 @@ def print_manager(manager):
         "PartNumber",
         "SparePartNumber",
         "SerialNumber",
+        "ServiceIdentification",
     ]
     print("Manager {} Info".format(manager.dict["Id"]))
     for property in manager_properties:

scripts/rf_manager_config.py

@@ -88,6 +88,8 @@
 setprotocol_argget.add_argument("--enable", "-en", action="store_true", help="Enable the selected protocol")
 setprotocol_argget.add_argument("--disable", "-dis", action="store_true", help="Disable the selected protocol")
 setprotocol_argget.add_argument("--port", "-port", type=int, help="The port number to assign the protocol")
+setserviceid_argget = subparsers.add_parser("setserviceid", help="Sets the service identification for a manager")
+setserviceid_argget.add_argument("--id", "-i", type=str, required=True, help="The service identification to set")
 args = argget.parse_args()
 
 if args.debug:
@@ -215,6 +217,9 @@
             network_protocol_setting[args.protocol]["Port"] = args.port
         print("Configuring {}...".format(args.protocol))
         redfish_utilities.set_manager_network_protocol(redfish_obj, args.manager, network_protocol_setting)
+    elif args.command == "setserviceid":
+        print("Setting the identification to '{}'...".format(args.id))
+        redfish_utilities.set_manager(redfish_obj, args.manager, service_id=args.id)
     else:
         manager = redfish_utilities.get_manager(redfish_obj, args.manager)
         redfish_utilities.print_manager(manager)