Example Zowe configuation setups

Flat Zowe team configuration

{
  "$schema": "./zowe.schema.json",
  "profiles": {
    "zosmf": {
      "type": "zosmf",
      "properties": {
        "port": 443
      },
      "secure": []
    },
    "tso": {
      "type": "tso",
      "properties": {
        "account": "",
        "codePage": "1047",
        "logonProcedure": "IZUFPROC"
      },
      "secure": []
    },
    "ssh": {
      "type": "ssh",
      "properties": {
        "port": 22
      },
      "secure": []
    },
    "rse": {
      "type": "rse",
      "properties": {
        "port": 6800,
        "basePath": "rseapi",
        "protocol": "https"
      },
      "secure": []
    },
    # common properties can be defined in the base profile insread of defining them in every profile
    "base": {
      "type": "base",
      "properties": {
        "host": "myzos.ibm.com",
        # reject connection if self-signed certificate is used
        "rejectUnauthorized": true
      },
      # these secure fields will determine the values written to and stored in the OS credential manager.
      "secure": ["user", "password"]
    }
  },
  "defaults": {
    "zosmf": "zosmf",
    "tso": "tso",
    "ssh": "ssh",
    "rse": "rse",
    "base": "base"
  },
  # setting determines if information is written to the file or credential manager
  "autoStore": true
}

Nested Zowe team configuration

Nested team configurations are great option for users that have multiple LPAR connections.

{
  "$schema": "./zowe.schema.json",
  "profiles": {
    "lpar1": {
      "properties": {
        "host": "lpar1.com",
        "rejectUnauthorized": false
      },
      "secure": ["user", "password"],       # Example of shared credentials across LPAR profiles
      "profiles": {
        "zosmf": {
          "type": "zosmf",
          "properties": {
            "port": 443
          }
        },
        "rse": {
          "type": "rse",
          "properties": {
            "port": 6800,
            "basePath": "rseapi",
            "protocol": "https"
          }
        },
        "ssh": {
          "type": "ssh",
          "properties": {
            "port": 22
          }
        }
      }
    },
    "lpar2": {
      "properties": {
        "host": "lpar2.com",
        "rejectUnauthorized": false
      },
      "profiles": {
        "zosmf": {
          "type": "zosmf",
          "properties": {
            "port": 443
          },
          "secure": ["user", "password"]    # Example of credentials that are profile specific
        },
        "ssh": {
          "type": "ssh",
          "properties": {
            "port": 22
          },
          "secure": ["user", "password"]
        }
      }
    },
    "lpar3": {
      "properties": {
        "host": "lpar3.com",
        "rejectUnauthorized": false
      },
      "secure": ["user", "password"],
      "profiles": {
        "zosmf": {
          "type": "zosmf",
          "properties": {
            "port": 3128,
            "protocol": "http"
          }
        }
      }
    }
  },
  "defaults": {
    "zosmf": "lpar1.zosmf",
    "ssh": "lpar1.ssh",
    "rse": "lpar1.rse"
  },
  "autoStore": true
}

RSE profiles connection type setup

RSE profile with Base profile using direct connection basic authentication

{
  "$schema": "./zowe.schema.json",
  "profiles": {
    "rse": {
      "type": "rse",
      "properties": {
        "port": 6803,
        "basePath": "rseapi",               #RSE Rest API Port
        "protocol": "https"                 #RSE Rest API base path
      },
      "secure": []
    },
    "base": {
      "type": "base",
      "properties": {
        "host": "examplehost.com",
        "rejectUnauthorized": true
      },
      "secure": ["user", "password"]
    }
  },
  "defaults": {
    "rse": "rse",
    "base": "base"
  },
  "autoStore": true
}

RSE profile using direct connection token authentication

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "rse": {
          "type": "rse",
          "properties": {
            "host": "examplehost.com",
            "port": 6800,                   #RSE Rest API Port
            "basePath": "rseapi",           #RSE Rest API base path
            "rejectUnauthorized": true
          },
          "secure": ["tokenValue"]
      },
    },
    "defaults": {
        "rse": "rse"
    },
    "autoStore": true
}

RSE profiles using API Mediation Layer for authentication

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "rse": {
            "type": "rse",
            "properties": {
                "port": 7554,                 #API ML Port
                "basePath": "ibmrse"          #API ML base path to registered RSE API
            }
        },
        "base": {
            "type": "base",
            "properties": {
                "host": "host.com",
                "rejectUnauthorized": true
            },
            "secure": [
              "tokenValue"
            ]
        }
    },
    "defaults": {
        "rse": "rse",
        "base": "base"
    },
    "autoStore": true
}
Last Updated:
Contributors: Billie Simmons