airshipctl/cmd/baremetal/ejectmedia.go
Sirisha Gopigiri ec3840a866 Baremetal- updating cmd files for documentation
The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: I323fa145b512e58cb878b117656c51bc39e76360
2021-05-07 19:23:55 +05:30

55 lines
1.6 KiB
Go

/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package baremetal
import (
"fmt"
"github.com/spf13/cobra"
"opendev.org/airship/airshipctl/pkg/config"
"opendev.org/airship/airshipctl/pkg/inventory"
"opendev.org/airship/airshipctl/pkg/inventory/ifc"
)
var (
ejectMediaCommand = "ejectmedia"
ejectMediaLong = fmt.Sprintf(`
Eject virtual media attached to a bare metal host. %s
`, selectorsDescription)
ejectMediaExample = fmt.Sprintf(bmhActionExampleTemplate, ejectMediaCommand)
)
// NewEjectMediaCommand provides a command to eject media attached to a baremetal host.
func NewEjectMediaCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command {
cmd := &cobra.Command{
Use: ejectMediaCommand,
Short: "Airshipctl command to eject virtual media attached to a bare metal host",
Long: ejectMediaLong[1:],
Example: ejectMediaExample,
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error {
return options.BMHAction(ifc.BaremetalOperationEjectVirtualMedia)
},
}
initFlags(options, cmd)
initAllFlag(options, cmd)
return cmd
}