msf_config

msf_config holds connection settings for one or more Metasploit RPC daemon (msfrpcd) instances. Each connection is identified by a name. The first defined connection is used by default when a command does not specify one explicitly.

msf_config:
  primary:
    password: securepassword
    server: 10.18.3.86

Multiple servers can be defined and selected per command via the connection field:

msf_config:
  server1:
    password: securepassword
    server: 10.18.3.86
  server2:
    password: anothersecret
    server: 10.18.3.87

Note

Backwards compatibility: The legacy single-server format is still accepted and is automatically migrated to a named entry called default:

# Legacy format (still supported)
msf_config:
  password: securepassword
  server: 10.18.3.86
server

The servername or IP address of the msfrpcd.

Type:

str

Default:

127.0.0.1

port

Port on which msfrpcd is listening.

Type:

int

Default:

55553

uri

URI of the RPC API.

ssl

Enables encryption for the RPC connection.

Type:

bool

::default: True

password

The password for the RPC connection.

Type:

str

Default:

None