github.com/vmware/govmomi@v0.43.0/govc/session/logout.go (about)

     1  /*
     2  Copyright (c) 2018 VMware, Inc. All Rights Reserved.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package session
    18  
    19  import (
    20  	"context"
    21  	"flag"
    22  
    23  	"github.com/vmware/govmomi/govc/cli"
    24  	"github.com/vmware/govmomi/govc/flags"
    25  	"github.com/vmware/govmomi/session"
    26  )
    27  
    28  type logout struct {
    29  	*flags.ClientFlag
    30  
    31  	vapi bool
    32  }
    33  
    34  func init() {
    35  	cli.Register("session.logout", &logout{})
    36  }
    37  
    38  func (cmd *logout) Register(ctx context.Context, f *flag.FlagSet) {
    39  	cmd.ClientFlag, ctx = flags.NewClientFlag(ctx)
    40  	cmd.ClientFlag.Register(ctx, f)
    41  
    42  	f.BoolVar(&cmd.vapi, "r", false, "REST logout")
    43  }
    44  
    45  func (cmd *logout) Process(ctx context.Context) error {
    46  	return cmd.ClientFlag.Process(ctx)
    47  }
    48  
    49  func (cmd *logout) Description() string {
    50  	return `Logout the current session.
    51  
    52  By default, govc commands persist sessions and do not logout unless '-persist-session=false' is set.
    53  The session.logout command can be used to end the current persisted session.
    54  The session.rm command can be used to remove sessions other than the current session.
    55  
    56  Examples:
    57    govc session.logout`
    58  }
    59  
    60  func (cmd *logout) Run(ctx context.Context, f *flag.FlagSet) error {
    61  	c, err := cmd.Client()
    62  	if err != nil {
    63  		return err
    64  	}
    65  
    66  	err = session.NewManager(c).Logout(ctx)
    67  
    68  	if cmd.vapi {
    69  		rc, err := cmd.RestClient()
    70  		if err != nil {
    71  			return err
    72  		}
    73  		return rc.Logout(ctx)
    74  	}
    75  
    76  	return err
    77  }