1*f7f4a2b9SMatt Spinlerdescription: > 2*f7f4a2b9SMatt Spinler Implement to provide an interface to start a failover. Depending on the 3*f7f4a2b9SMatt Spinler implementation, this may reside on the 'from' or 'to' object (or both). The 4*f7f4a2b9SMatt Spinler 'Options' method argument provides a mechanism to provide implementation 5*f7f4a2b9SMatt Spinler specific options. 6*f7f4a2b9SMatt Spinler 7*f7f4a2b9SMatt Spinlermethods: 8*f7f4a2b9SMatt Spinler - name: StartFailover 9*f7f4a2b9SMatt Spinler description: > 10*f7f4a2b9SMatt Spinler Starts a failover operation. 11*f7f4a2b9SMatt Spinler parameters: 12*f7f4a2b9SMatt Spinler - name: Options 13*f7f4a2b9SMatt Spinler type: dict[string, variant[boolean]] 14*f7f4a2b9SMatt Spinler description: > 15*f7f4a2b9SMatt Spinler Additional options. The key is the string version of the Options 16*f7f4a2b9SMatt Spinler enum, in the form of 17*f7f4a2b9SMatt Spinler 'xyz.openbmc_project.Control.Failover.Options.X'. 18*f7f4a2b9SMatt Spinler errors: 19*f7f4a2b9SMatt Spinler - xyz.openbmc_project.Common.Error.Unavailable 20*f7f4a2b9SMatt Spinler 21*f7f4a2b9SMatt Spinlerenumerations: 22*f7f4a2b9SMatt Spinler - name: Options 23*f7f4a2b9SMatt Spinler description: > 24*f7f4a2b9SMatt Spinler Available options for starting the failover. 25*f7f4a2b9SMatt Spinler values: 26*f7f4a2b9SMatt Spinler - name: "Force" 27*f7f4a2b9SMatt Spinler description: > 28*f7f4a2b9SMatt Spinler A boolean option to force the failover when it would normally 29*f7f4a2b9SMatt Spinler not be available. The checks it bypasses are implementation 30*f7f4a2b9SMatt Spinler dependent. 31