1f7f4a2b9SMatt Spinlerdescription: > 2f7f4a2b9SMatt Spinler Implement to provide an interface to start a failover. Depending on the 3f7f4a2b9SMatt Spinler implementation, this may reside on the 'from' or 'to' object (or both). The 4f7f4a2b9SMatt Spinler 'Options' method argument provides a mechanism to provide implementation 5f7f4a2b9SMatt Spinler specific options. 6f7f4a2b9SMatt Spinler 7f7f4a2b9SMatt Spinlermethods: 8f7f4a2b9SMatt Spinler - name: StartFailover 9f7f4a2b9SMatt Spinler description: > 10f7f4a2b9SMatt Spinler Starts a failover operation. 11f7f4a2b9SMatt Spinler parameters: 12*f85ae8afSMatt Spinler - name: Requester 13*f85ae8afSMatt Spinler type: enum[self.Requester] 14*f85ae8afSMatt Spinler description: > 15*f85ae8afSMatt Spinler Identifies who's requesting the failover 16f7f4a2b9SMatt Spinler - name: Options 17f7f4a2b9SMatt Spinler type: dict[string, variant[boolean]] 18f7f4a2b9SMatt Spinler description: > 19f7f4a2b9SMatt Spinler Additional options. The key is the string version of the Options 20f7f4a2b9SMatt Spinler enum, in the form of 21f7f4a2b9SMatt Spinler 'xyz.openbmc_project.Control.Failover.Options.X'. 22f7f4a2b9SMatt Spinler errors: 23f7f4a2b9SMatt Spinler - xyz.openbmc_project.Common.Error.Unavailable 24f7f4a2b9SMatt Spinler 25f7f4a2b9SMatt Spinlerenumerations: 26*f85ae8afSMatt Spinler - name: Requester 27*f85ae8afSMatt Spinler description: > 28*f85ae8afSMatt Spinler Who is requesting the failover. 29*f85ae8afSMatt Spinler values: 30*f85ae8afSMatt Spinler - name: Host 31*f85ae8afSMatt Spinler description: > 32*f85ae8afSMatt Spinler The host is requesting the failover. 33*f85ae8afSMatt Spinler - name: Redfish 34*f85ae8afSMatt Spinler description: > 35*f85ae8afSMatt Spinler A Redfish client is requesting the failover. 36*f85ae8afSMatt Spinler - name: SystemConfig 37*f85ae8afSMatt Spinler description: > 38*f85ae8afSMatt Spinler A system config checker on the BMC is requesting the failover. 39*f85ae8afSMatt Spinler - name: Tool 40*f85ae8afSMatt Spinler description: > 41*f85ae8afSMatt Spinler A command line tool is requesting the failover. 42f7f4a2b9SMatt Spinler - name: Options 43f7f4a2b9SMatt Spinler description: > 44f7f4a2b9SMatt Spinler Available options for starting the failover. 45f7f4a2b9SMatt Spinler values: 46f7f4a2b9SMatt Spinler - name: "Force" 47f7f4a2b9SMatt Spinler description: > 48f7f4a2b9SMatt Spinler A boolean option to force the failover when it would normally 49f7f4a2b9SMatt Spinler not be available. The checks it bypasses are implementation 50f7f4a2b9SMatt Spinler dependent. 51